-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
62 lines (43 loc) · 2.64 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# staninside
<!-- badges: start -->
[](https://github.com/medewitt/staninside/actions)
[](https://codecov.io/gh/medewitt/staninside?branch=main)
[](https://CRAN.R-project.org/package=staninside)
<!-- badges: end -->
The goal of staninside is to facilitate the use of [CmdStanR](https://mc-stan.org/cmdstanr/) and packages leveraging [Stan](https://mc-stan.org/) code.
## Installation
From Github:
``` r
remotes::install_github("medewitt/staninside")
```
Alternatively, try [r-universe](https://medewitt.r-universe.dev/ui#builds):
```r
# Enable this universe
options(repos = c(
medewitt = 'https://medewitt.r-universe.dev',
CRAN = 'https://cloud.r-project.org'))
install.packages('staninside')
```
## Motivation
CmdStanR is a fantastic resource for interacting with Stan.
The benefits include using the latest version of Stan and associated feature (which may not be available to RStan), no need for Rcpp dependencies, and licensing (BSD vs GPL3).
Personally, the ability to ship packages with the raw Stan code allows users to directly interact with the code and update it based on their needs.
One issue that staninside seeks to solve is the prohibition by CRAN of manipulating a user's files:
>Packages should not write in the user’s home filespace (including clipboards), nor anywhere else on the file system apart from the R session’s temporary directory (or during installation in the location pointed to by TMPDIR: and such usage should be cleaned up). Installing into the system’s R installation (e.g., scripts to its bin directory) is not allowed.
Per <https://cran.r-project.org/web/packages/policies.html>
Staninside seeks to resolve this issue by providing a framework for package authors who wish to use Stan and CmdStanR to stay in compliance with CRAN Policies.
This is done by providing helper functions with write and compile Stan code from within a package to the user's package cache using the `rappdirs` package.
## Code of Conduct
Please note that the staninside project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.