Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
59 changes: 59 additions & 0 deletions .github/workflows/pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
# build dev site on merged pushes
push:
branches: [develop]
# build full site on releases
release:
types: [published]
workflow_dispatch:

name: pkgdown.yaml

jobs:
pkgdown:
runs-on: ubuntu-latest
# Only restrict concurrency for non-PR jobs
concurrency:
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
cancel-in-progress: true
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
NOT_CRAN: true
permissions:
contents: write
steps:
- uses: actions/checkout@v6

- uses: r-lib/actions/setup-pandoc@v2

- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true
extra-repositories: 'https://stan-dev.r-universe.dev'

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::pkgdown, local::., stan-dev/pkgdown-config
working-directory: ./rstan/rstan

- name: Copy root README into package dir
run: cp ./README.md ./rstan/rstan/README.md

- name: Build site
run: |
pkgdown::build_site_github_pages(
lazy = FALSE, # change to TRUE if runner times out.
run_dont_run = TRUE,
new_process = TRUE
)
shell: Rscript {0}
working-directory: ./rstan/rstan

- name: Deploy to GitHub pages 🚀
uses: JamesIves/github-pages-deploy-action@v4
with:
clean: false
branch: gh-pages
folder: rstan/rstan/docs
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# RStan <img src="rstan/rstan/man/figures/stanlogo.png" align="right" width="120" />
# RStan <img src="rstan/rstan/man/figures/logo.svg" align="right" width="120" />

<!-- badges: start -->
[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/rstan?color=blue)](https://cran.r-project.org/package=rstan)
Expand Down
2 changes: 2 additions & 0 deletions rstan/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ tests/cpp/*
R_Makevars

rstan.Rcheck/

/rstan/README.md
50 changes: 50 additions & 0 deletions rstan/rstan/_pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
url: https://mc-stan.org/rstan

destination: "../.."

development:
mode: auto

template:
package: pkgdownconfig

navbar:
title: "rstan"

structure:
left: [home, vignettes, functions, news, pkgs, stan]
right: [search, bluesky, forum, github, lightswitch]

components:
pkgs:
text: Other Packages
menu:
- text: bayesplot
href: https://mc-stan.org/bayesplot
- text: cmdstanr
href: https://mc-stan.org/cmdstanr
- text: loo
href: https://mc-stan.org/loo
- text: posterior
href: https://mc-stan.org/posterior
- text: projpred
href: https://mc-stan.org/projpred
- text: rstanarm
href: https://mc-stan.org/rstanarm
- text: rstantools
href: https://mc-stan.org/rstantools
- text: shinystan
href: https://mc-stan.org/shinystan

articles:
- title: "Using the RStan package"
desc: >
These vignettes provide an introduction to fitting a model in
RStan, extracting the important contents from fitted model objects,
including external C++ code in a Stan program, and performing simulation
based calibration.
contents:
- rstan
- stanfit-objects
- external
- SBC
1 change: 1 addition & 0 deletions rstan/rstan/man/figures/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed rstan/rstan/man/figures/stanlogo.png
Binary file not shown.
2 changes: 1 addition & 1 deletion rstan/rstan/man/rstan.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
\title{RStan --- the \R interface to Stan}
\description{
\if{html}{
\figure{stanlogo.png}{options: width="50" alt="mc-stan.org"}
\figure{logo.svg}{options: width="50" alt="mc-stan.org"}
\emph{Stan Development Team}
}

Expand Down
2 changes: 1 addition & 1 deletion rstan/rstan/man/sbc.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
\alias{plot.sbc}
\title{Simulation Based Calibration (sbc)}
\description{
\if{html}{\figure{stanlogo.png}{options: width="25" alt="https://mc-stan.org/about/logo/"}}
\if{html}{\figure{logo.svg}{options: width="25" alt="https://mc-stan.org/about/logo/"}}
Check whether a model is well-calibrated with respect to the
prior distribution and hence possibly amenable to obtaining
a posterior distribution conditional on observed data.
Expand Down
4 changes: 2 additions & 2 deletions rstan/rstan/man/stan.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
\alias{stan}
\title{Fit a model with Stan}
\description{
\if{html}{\figure{stanlogo.png}{options: width="25" alt="https://mc-stan.org/about/logo/"}}
\if{html}{\figure{logo.svg}{options: width="25" alt="https://mc-stan.org/about/logo/"}}
Fit a model defined in the Stan modeling language and
return the fitted result as an instance of \code{stanfit}.
}
Expand Down Expand Up @@ -459,7 +459,7 @@ excode <- '
parameters {
real mu;
real<lower=0, upper=10> sigma;
vector[2] z[3];
array[3] vector[2] z;
real<lower=0> alpha;
}
model {
Expand Down
Loading