From a1dcbd091bd16feaa4249f79b88a57a0d418e3b4 Mon Sep 17 00:00:00 2001 From: Maia Kapur <39382798+mkapur-noaa@users.noreply.github.com> Date: Tue, 10 Dec 2024 13:27:07 -0800 Subject: [PATCH] test into vignette --- .Rbuildignore | 4 +++ .github/.gitignore | 1 + .github/workflows/pkgdown.yaml | 49 +++++++++++++++++++++++++++++++++ .gitignore | 1 + DESCRIPTION | 1 + _pkgdown.yml | 4 +++ vignettes/simulated_example.Rmd | 4 ++- 7 files changed, 63 insertions(+), 1 deletion(-) create mode 100644 .github/.gitignore create mode 100644 .github/workflows/pkgdown.yaml create mode 100644 _pkgdown.yml diff --git a/.Rbuildignore b/.Rbuildignore index 91114bf..91fb891 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,2 +1,6 @@ ^.*\.Rproj$ ^\.Rproj\.user$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ +^\.github$ diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..bfc9f4d --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -0,0 +1,49 @@ +# 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: + push: + branches: [main, master] + pull_request: + release: + types: [published] + workflow_dispatch: + +name: pkgdown.yaml + +permissions: read-all + +jobs: + pkgdown: + runs-on: ubuntu-latest + # Only restrict concurrency for non-PR jobs + concurrency: + group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }} + 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::. + needs: website + + - name: Build site + run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) + shell: Rscript {0} + + - name: Deploy to GitHub pages 🚀 + if: github.event_name != 'pull_request' + uses: JamesIves/github-pages-deploy-action@v4.5.0 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/.gitignore b/.gitignore index c833a2c..138866d 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ .RData .Ruserdata inst/doc +docs diff --git a/DESCRIPTION b/DESCRIPTION index 10491a5..1e62556 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -13,3 +13,4 @@ Suggests: knitr, rmarkdown VignetteBuilder: knitr +URL: https://afsc-assessments.github.io/growthbreaks/ diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..5d8c387 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,4 @@ +url: https://afsc-assessments.github.io/growthbreaks/ +template: + bootstrap: 5 + diff --git a/vignettes/simulated_example.Rmd b/vignettes/simulated_example.Rmd index 81d59ba..fae187e 100644 --- a/vignettes/simulated_example.Rmd +++ b/vignettes/simulated_example.Rmd @@ -15,5 +15,7 @@ knitr::opts_chunk$set( ``` ```{r setup} -library(growthbreaks) +# library(growthbreaks) ``` + +test