Skip to content

Fix pkgdown issues #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VisruthSK wants to merge 2 commits into
base: master
Choose a base branch
from
+7 −9
Open

Fix pkgdown issues #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
efc75bb
Bumped Roxygen to 8.0.0
VisruthSK Jul 17, 2026
ff70330
Fixed vignette
VisruthSK Jul 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,6 @@ Suggests:
roxygen2 (>= 6.0.1),

@jgabry jgabry Jul 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
roxygen2 (>= 6.0.1),
roxygen2 (>= 7.0.0),

I think the new vignette should work with v7 or greater

rmarkdown,
rstudioapi
RoxygenNote: 7.3.3
VignetteBuilder: knitr
Roxygen: list(markdown = TRUE)
Config/roxygen2/version: 8.0.0
2 changes: 2 additions & 0 deletions man/rstantools-package.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 4 additions & 8 deletions vignettes/minimal-rstan-package.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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)
Expand Down
Loading