diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml index 63cbb18..a7276e8 100644 --- a/.github/workflows/pkgdown.yaml +++ b/.github/workflows/pkgdown.yaml @@ -1,8 +1,10 @@ -# Workflow derived from https://github.com/r-lib/actions/tree/master/examples +# 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: + branches: [main, master] release: types: [published] workflow_dispatch: @@ -12,24 +14,35 @@ name: pkgdown 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@v2 + - uses: actions/checkout@v4 - - uses: r-lib/actions/setup-pandoc@v1 + - uses: r-lib/actions/setup-pandoc@v2 - - uses: r-lib/actions/setup-r@v1 + - uses: r-lib/actions/setup-r@v2 with: use-public-rspm: true - - uses: r-lib/actions/setup-r-dependencies@v1 + - uses: r-lib/actions/setup-r-dependencies@v2 with: - extra-packages: pkgdown + extra-packages: any::pkgdown, local::. needs: website - - 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)' + - 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/R/runSPM.R b/R/runSPM.R index 7f93bc5..8236c0f 100644 --- a/R/runSPM.R +++ b/R/runSPM.R @@ -6,6 +6,7 @@ #' #' @param dirname A string specifying the directory in which to run the SPM analysis. #' @param ctrl Optional control settings for the SPM analysis. If NULL, default settings are used. +#' @param run Logical. If TRUE, the SPM analysis is run. If FALSE, the function only reads the results from `spm_detail.csv`. #' @return A data frame containing the results from `spm_detail.csv`. #' @importFrom readr read_csv #' @examples diff --git a/_pkgdown.yml b/_pkgdown.yml index d71acfb..8c325a1 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,4 +1,6 @@ -url: ~ +url: http://afsc-assessments.github.io/spmR/ template: bootstrap: 5 +development: + mode: auto diff --git a/docs/404.html b/docs/404.html index 12f4f33..648dab0 100644 --- a/docs/404.html +++ b/docs/404.html @@ -25,7 +25,7 @@ spmR - 0.1.0 + 0.1.0
+ +The R package spmR
was developed for doing stock projections for groundfish at the AFSC. The model was coded using the Autodif (AD
) Model Builder (ADMB
) software.
The R package spmR
lives on a public GitHub repository. The repository can be cloned to your computer from the command line or using a user interface. From the command line using Linux the repository can be cloned using:
There are several options for installing the spmR
R package.
The spmR
package can be installed from within R using:
+devtools::install_github(repo = "afsc-assessments/spmR", dependencies = TRUE,
+ build_vignettes = TRUE, auth_token = "your_PAT")
Help for all spmR
functions and data sets can be found on the R help pages associated with each function and data set. Help for a specific function can be viewed using ?function_name
, for example:
+?run_model
+?tab_fit
+?plot_sel
Alternatively, to see a list of all available functions and data sets use:
+
+help(package = "spmR")
The package vignettes are a great place to see what spmR
can do. You can view the package vignettes from within R using:
+browseVignettes(package = "spmR")
+vignette(topic = "spmR", package = "spmR")
All of the vignettes and the help pages for each function are bundled together and published on the website https://afsc-assessments.github.io/spmR/.
+NOAA: National Oceanic and Atmospheric Administration
+NMFS: National Marine Fisheries Service
+AFSC: Alaska Fisheries Science Center
+REFM: Resource and Ecology and Fisheries Management
This repository is a software product and is not official communication of the National Oceanic and Atmospheric Administration (NOAA), or the United States Department of Commerce (DOC). All NOAA GitHub project code is provided on an ‘as is’ basis and the user assumes responsibility for its use. Any claims against the DOC or DOC bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation, or favoring by the DOC. The DOC seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by the DOC or the United States Government.
+