Skip to content

Commit

Permalink
Workflow docs
Browse files Browse the repository at this point in the history
  • Loading branch information
klau506 committed Mar 19, 2024
1 parent d8f9c13 commit 7fc9937
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 3 deletions.
3 changes: 2 additions & 1 deletion docs/articles/tutorial.html

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

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ pkgdown: 2.0.7
pkgdown_sha: ~
articles:
tutorial: tutorial.html
last_built: 2024-03-19T14:24Z
last_built: 2024-03-19T14:25Z
urls:
reference: https://bc3lc.github.io/gcamreport/reference
article: https://bc3lc.github.io/gcamreport/articles
Expand Down
2 changes: 1 addition & 1 deletion vignettes/tutorial.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ In addition to the main graph interface, rfasstui also has a few other outputs.

Tutorial Step 1: Getting Started | Example
------------- | ---------
To begin the tutorial, make sure you are in the “Explore rfasst” tab and click the any of the “Standard Scenarios” available, or leave it as rfasst default. The different scenarios contain unique input parameters that drive the rfasst model’s output. For the purposes of this experiment you may choose whichever you like. | ![Explore rfasst](https://raw.githubusercontent.com/bc3LC/rfasstui/main/vignettes/vig_figures/vig1.png){width=350px}
To begin the tutorial, make sure you are in the “Explore rfasst” tab and click the any of the “Standard Scenarios” available, or leave it as rfasst default. The different scenarios contain unique input parameters that drive the rfasst model’s output. For the purposes of this experiment you may choose whichever you like. Click the ‘Load Graphs’ button!| ![Explore rfasst](https://raw.githubusercontent.com/bc3LC/rfasstui/main/vignettes/vig_figures/vig1.png){width=350px}

Tutorial Step 2: Downloading data and figures | Example
------------- | ---------
Expand Down
58 changes: 58 additions & 0 deletions workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: docs

on:
push:
branches:
- main

jobs:
pkgdown:
runs-on: ubuntu-latest

env:
R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
GITHUB_PAT: ${{ secrets.GH_RFASSTUI_TOKEN}}
RSPM: ${{ matrix.config.rspm }}

steps:
- uses: actions/checkout@v2

- uses: r-lib/actions/setup-r@v2
with:
r-version: '4.1.0'

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

- name: Install libraries
run: |
sudo apt-get update
sudo apt-get install -y libcurl4-openssl-dev libharfbuzz-dev libfribidi-dev libssl-dev libxml2-dev libudunits2-dev libgdal-dev libgeos-dev libproj-dev libmagick++-dev libavfilter-dev
- name: Restart R
run: |
R --vanilla --quiet
echo 'q()' | R --no-save
- name: Install dependencies 1
run: |
install.packages(c("remotes", "rcmdcheck"), repos = "https://cloud.r-project.org")
shell: Rscript {0}

- name: Install dependencies 2
run: |
remotes::install_deps(dependencies = TRUE)
shell: Rscript {0}

- name: Install dependencies 3
run: |
install.packages("pkgdown")
shell: Rscript {0}

- name: Install package
run: R CMD INSTALL .

- name: Deploy package
run: |
git config --local user.name "$GITHUB_ACTOR"
git config --local user.email "$GITHUB_ACTOR@users.noreply.github.com"
Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'

0 comments on commit 7fc9937

Please sign in to comment.