Merge pull request #206 from stan-dev/new-pkgdown-theme

Added pkgdown workflow

Author: jgabry

.Rbuildignore

@@ -10,3 +10,4 @@ LICENSE
 man-roxygen/*
 images/*
 ^\.github$
+^pkgdown$

.github/workflows/pkgdown.yaml

@@ -0,0 +1,56 @@
+# 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: [main, master]
+  # 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 }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::., any::withr, stan-dev/pkgdown-config, stan-dev/cmdstanr
+
+      - name: Build site
+        run: |
+          withr::with_envvar(
+            c("NOT_CRAN" = "true"), # this should already be set by setup-r@v2? keeping because vignettes don't build otherwise
+            pkgdown::build_site_github_pages(
+              lazy = FALSE, # change to TRUE if runner times out.
+              run_dont_run = FALSE, # shinystan is interactive so hangs
+              examples = FALSE,
+              new_process = TRUE
+            )
+          )
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

R/shinystan-package.R

@@ -10,15 +10,14 @@
 # You should have received a copy of the GNU General Public License along with
 # this program; if not, see <http://www.gnu.org/licenses/>.
 
-
 #' \pkg{shinystan} R package ('ShinyStan' graphical user interface)
 #'
 #' @docType package
 #' @name shinystan-package
 #'
 #' @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}
 #' }
 #'
@@ -54,7 +53,7 @@
 #'   publication.
 #'
 #'   The \code{\link{deploy_shinystan}} function lets you easily deploy your own
-#'   ShinyStan apps online for any of your models using the shinyapps.io 
+#'   ShinyStan apps online for any of your models using the shinyapps.io
 #'   service from 'RStudio'. Each of your apps (each of your models) will have a
 #'   unique url and will be compatible with most web browsers.
 #'
@@ -79,7 +78,7 @@
 #' @template seealso-as.shinystan
 #' @template seealso-demo
 #' @template seealso-launch
-#' 
+#'
 #' @template reference-muth
 #' @template reference-bayesvis
 #'

README.md

@@ -1,4 +1,4 @@
-# ShinyStan <img src="man/figures/stanlogo.png" align="right" width="120" />
+# ShinyStan <img src="man/figures/logo.svg" align="right" width="120" />
 
 <!-- badges: start -->
 [![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/shinystan?color=blue)](http://cran.r-project.org/web/packages/shinystan)
@@ -46,7 +46,7 @@ launch_shinystan_demo()
 
 ### Screenshots
 
-<img src=https://github.com/stan-dev/shinystan/blob/master/images/home.png width=19% /><img src=https://github.com/stan-dev/shinystan/blob/master/images/explore.png width=24.5% /><img src=https://github.com/stan-dev/shinystan/blob/master/images/diagnose.png width=24.5% />
+<img src=https://github.com/stan-dev/shinystan/raw/master/images/home.png width=19% /><img src=https://github.com/stan-dev/shinystan/raw/master/images/explore.png width=24.5% /><img src=https://github.com/stan-dev/shinystan/raw/master/images/diagnose.png width=24.5% />
 
 ### About ShinyStan
 

_pkgdown.yml

@@ -0,0 +1,80 @@
+url: https://mc-stan.org/shinystan
+
+destination: "."
+
+development:
+  mode: auto
+
+template:
+  package: pkgdownconfig
+
+navbar:
+  title: "shinystan"
+
+  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: rstan
+          href: https://mc-stan.org/rstan
+        - text: rstanarm
+          href: https://mc-stan.org/rstanarm
+        - text: rstantools
+          href: https://mc-stan.org/rstantools
+
+articles:
+  - title: "Getting Started"
+    desc: >
+      The best way to get started is to play around with the demo by running 
+      launch_shinystan_demo(). The document below provides additional 
+      information about some of the R functions in the package. 
+    contents:
+      - shinystan-package
+  - title: "Hosting your App"
+    desc: >
+      The document below explains one way to host a shinystan app online.
+    contents:
+      - deploy_shinystan
+
+reference:
+  - title: "Package overview"
+    desc: > 
+      Details about the shinystan R package.
+    contents: 
+      - shinystan-package
+  - title: "Launching the app"
+    desc: >
+      Functions for launching the app using a particular model or launching a demo of the app.
+    contents:
+      - launch_shinystan
+      - launch_shinystan_demo
+  - title: "shinystan objects"
+    desc: >
+      Functions for creating, examining, and modifying shinystan objects.
+    contents:
+      - as.shinystan
+      - shinystan-class
+      - shinystan-metadata
+      - retrieve
+      - drop_parameters
+      - update_sso
+      - generate_quantity
+  - title: "Deploying apps"
+    desc: >
+      Functions for deploying shinystan apps on shinyapps.io.
+    contents:
+      - deploy_shinystan