R: Create a skeleton for a new R package with Stan programs

rstan_package_skeleton {rstantools}

R Documentation

Create a skeleton for a new R package with Stan programs

Description

This function is very similar to package.skeleton but is designed for source packages that want to include Stan Programs that can be built into binary versions.

Usage

rstan_package_skeleton(name = "anRpackage", list = character(),
  environment = .GlobalEnv, path = ".", force = FALSE,
  code_files = character(), stan_files = character(), travis = TRUE)

Arguments

`name, list, environment, path, force, code_files`	Same as in `package.skeleton`.
`stan_files`	A character vector with paths to `.stan` files to include in the package. Otherwise similar to `code_files`.
`travis`	Should a `.travis.yml` file be added to the package directory? Defaults to `TRUE`.

Details

This function first calls package.skeleton and then adds the files listed in stan_files to an exec directory. Finally, it downloads several files from the rstanarm package's GitHub repository to facilitate building the resulting package. Note that rstanarm is licensed under the GPL >= 3, so package builders who do not want to be governed by that license should not use the downloaded files that contain R code. Otherwise, it may be worth considering whether it would be easier to include your .stan programs and supporting R code in the rstanarm package.

After running rstan_package_skeleton see the Read-and-delete-me file created in the package directory. The content in that file contains the content of the Read-and-delete-me file created by package.skeleton plus additional Stan-specific instructions.

Create a skeleton for a new R package with Stan programs

Description

Usage

Arguments

Details

See Also