diff --git a/DESCRIPTION b/DESCRIPTION index af1d142..ab7a148 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -56,6 +56,6 @@ Suggests: roxygen2 (>= 6.0.1), rmarkdown, rstudioapi -RoxygenNote: 7.3.3 VignetteBuilder: knitr Roxygen: list(markdown = TRUE) +Config/roxygen2/version: 8.0.0 diff --git a/man/rstantools-package.Rd b/man/rstantools-package.Rd index 327d82d..277fe3b 100644 --- a/man/rstantools-package.Rd +++ b/man/rstantools-package.Rd @@ -44,6 +44,7 @@ Useful links: Authors: \itemize{ + \item Jonah Gabry \email{jgabry@gmail.com} \item Ben Goodrich \email{benjamin.goodrich@columbia.edu} \item Martin Lysy \email{mlysy@uwaterloo.ca} \item Andrew Johnson @@ -54,6 +55,7 @@ Other contributors: \item Hamada S. Badr [contributor] \item Marco Colombo [contributor] \item Stefan Siegert [contributor] + \item Visruth Srimath Kandali [contributor] \item Trustees of Columbia University [copyright holder] } diff --git a/vignettes/minimal-rstan-package.Rmd b/vignettes/minimal-rstan-package.Rmd index e0fa99e..4bab8e0 100644 --- a/vignettes/minimal-rstan-package.Rmd +++ b/vignettes/minimal-rstan-package.Rmd @@ -157,7 +157,6 @@ model { } " writeLines(stan_prog, con = file.path(PATH, "inst", "stan", "lm.stan")) -rstan_config(PATH) ``` The `inst/stan` subdirectory can contain additional Stan programs if @@ -179,7 +178,7 @@ the package functions. The following comment block placed in `lm_stan.R` ensures that the function has a help file and that it is added to the package `NAMESPACE`: -```{r} +```{r, eval=FALSE} # Save this file as `R/lm_stan.R` #' Bayesian linear regression with Stan @@ -244,8 +243,8 @@ roxygen2::roxygenize() ``` ```{r, echo=FALSE, results="hide"} -try(roxygen2::roxygenize(PATH, load_code = rstantools_load_code), silent = TRUE) -roxygen2::roxygenize(PATH) +roxygen2::roxygenize(PATH, load_code = roxygen2::load_source) +rstan_config(PATH) ``` ## Install and use @@ -268,11 +267,8 @@ documentation, you can set `quick=TRUE` to speed up the process, or use After installation, the package can be loaded and used like any other R package: -```{r, eval=FALSE} -library("rstanlm") -``` - ```{r} +library(rstanlm) fit <- lm_stan(y = rnorm(10), x = rnorm(10), # arguments passed to sampling iter = 2000, refresh = 500)