Merge pull request #190 from PlanktonTeam/MiscUpdates

Minor updates

.github/workflows/R-CMD-check.yaml

@@ -1,4 +1,4 @@
-# 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:
@@ -15,14 +15,15 @@ jobs:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
       R_KEEP_PKG_SOURCE: yes
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - 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: rcmdcheck
+          extra-packages: any::rcmdcheck
+          needs: check
 
-      - uses: r-lib/actions/check-r-package@v1
+      - uses: r-lib/actions/check-r-package@v2

R/utils_boo_data.R

@@ -537,7 +537,7 @@ pr_get_Papers <- function(){
 #'
 #' @param Survey one of NRS, CPR or Both
 #' @param interactive A logical TRUE/FALSE if the data is to be used for an interactive plot.
-#' @param ... Open for other arguments
+#' @param ... variables to be passed to pr_add_Bioregions. At the moment it only supports `near_dist_km` which is the distance (km) around each bioregion to pad the allocation of points.
 #'
 #' @return A dataframe for input into pr_plot_Progress()
 #' @export

R/utils_indices.R

@@ -2,7 +2,7 @@
 #'
 #' @param Survey CPR or NRS, defaults to NRS
 #' @param Type Phyto, zoo or physical water props, defaults to phyto
-#' @param ... to allow use of join when used within another function
+#' @param ... variables to be passed to pr_add_Bioregions. At the moment it only supports `near_dist_km` which is the distance (km) around each bioregion to pad the allocation of points.
 #'
 #' @return dataframe to use in pr_plot functions
 #' @export

README.Rmd

@@ -17,7 +17,7 @@ knitr::opts_chunk$set(
 
 <!-- badges: start -->
 [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
-[![R-CMD-check](https://github.com/PlanktonTeam/planktonr/workflows/R-CMD-check/badge.svg)](https://github.com/PlanktonTeam/planktonr/actions)
+[![R-CMD-check](https://github.com/PlanktonTeam/planktonr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/PlanktonTeam/planktonr/actions/workflows/R-CMD-check.yaml)
 [![Codecov test coverage](https://codecov.io/gh/PlanktonTeam/planktonr/branch/master/graph/badge.svg)](https://app.codecov.io/gh/PlanktonTeam/planktonr?branch=master)
 <!-- badges: end -->
 

README.md

@@ -7,7 +7,7 @@
 
 [![Lifecycle:
 experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
-[![R-CMD-check](https://github.com/PlanktonTeam/planktonr/workflows/R-CMD-check/badge.svg)](https://github.com/PlanktonTeam/planktonr/actions)
+[![R-CMD-check](https://github.com/PlanktonTeam/planktonr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/PlanktonTeam/planktonr/actions/workflows/R-CMD-check.yaml)
 [![Codecov test
 coverage](https://codecov.io/gh/PlanktonTeam/planktonr/branch/master/graph/badge.svg)](https://app.codecov.io/gh/PlanktonTeam/planktonr?branch=master)
 <!-- badges: end -->