rstan_package_skeleton: Create the skeleton of a new R package with Stan programs
Description
The rstan_package_skeleton function helps get you started developing
R packages that interface with Stan via the rstan package. As of
rstantools v1.5.0, rstan_package_skeleton calls
usethis::create_package (instead of utils::package.skeleton)
and then makes necessary adjustments so that the package can include Stan
Programs that can be built into binary versions (i.e., pre-compiled like
rstanarm).
See the See Also section below for links to recommendations for
developers and a step by step walk-through of what to do after running
rstan_package_skeleton.
Usage
rstan_package_skeleton(path, fields = getOption("devtools.desc"),
rstudio = TRUE, open = TRUE, stan_files = character(), travis = TRUE)Arguments
A relative or absolute path to the new package to be created (terminating in the package name).
See usethis::create_package.
A character vector with paths to .stan files to
include in the package (these files will be included in the
src/stan_files directory). If not specified then the .stan
files for the package can be manually placed into the appropriate directory
later.
Should a .travis.yml file be added to the package
directory? Defaults to TRUE. The file has some settings already set
to help with compilation issues, but we do not guarantee that it will work
on travis-ci without manual adjustments.
See Also
Guidelines and recommendations for developers of R packages interfacing with Stan and a demonstration getting a simple package working can be found in the vignettes included with rstantools and at http://mc-stan.org/rstantools/articles/.
After reading the guidelines for developers, if you have trouble setting up your package let us know on the the Stan Forums or at rstantools issue tracker.
The useR2016 presentation How to Use (R)Stan to Estimate Models in External R Packages.