Merge pull request #271 from bcgov/devl

documentation for name_changes

R/name_changes.R

@@ -0,0 +1,13 @@
+#' Changes to naming conventions applied in Version 0.1.0
+#'
+#' A table of correspondence between old and new names for functions, parameters, and options. 
+#' For changes in climate variable names, see `data(variables)`.
+#'
+#' @format A `data.table` with columns:
+#' \describe{
+#'   \item{type}{The type of object that was renamed}
+#'   \item{function}{The function whose contents were renamed, if applicable}
+#'   \item{name_old}{The old name, pre-v0.1.0}
+#'   \item{name_new}{The new name, as of v0.1.0}
+#' }
+"name_changes"

_pkgdown.yml

@@ -41,16 +41,14 @@ articles:
 reference:
 - title: "Downscaling functions"
   desc: >
-    Functions to used to downscale climate variables
+    Functions for downscaling climate variables
   contents:
   - climr
   - downscale
   - downscale_core
 - title: "Downloading raw climate inputs"
   desc: >
-    Functions to download climate normals and
-    historic/future anomalies used for downscaling
-    climate elements and derived variables
+    Functions to generate inputs for downscale_core()
   contents:
   - input_refmap
   - input_gcms
@@ -60,7 +58,7 @@ reference:
   - input_obs_ts
 - title: "Database and caching"
   desc: > 
-    Functions used to interact with the PostGIS server
+    Functions for interacting with the PostGIS server
     and the data cache folder
   contents:
   - cache_clear
@@ -78,11 +76,11 @@ reference:
   - lapse_rate
 - title: "Data"
   desc: >
-    available climate variables and functions listing 
-    available data.
-    Datasets used in vignettes and examples,
+    Available climate variables and functions listing available data.
+    Datasets used in vignettes and examples.
   contents:
   - variables
+  - name_changes
   - list_refmaps
   - list_obs_periods
   - list_gcms

vignettes/guidance_ensembleSelection.Rmd

@@ -23,17 +23,9 @@ Colin Mahony
 Research Climatologist\
 British Columbia Ministry of Forests
 
-Released: April 26, 2021
-
-## Purpose
-
-This guidance is developed by the BC Ministry of Forests for users of
-`climr`. This guidance is professional opinion and does not represent
-government policy.
-
 ## Model selection
 
-Wherever possible, climate change studies benefit from the use of
+Wherever possible, climate change studies will benefit from the use of
 projections from multiple models to assess modeling uncertainties. There
 is broad scientific agreement that an ensemble of at least eight
 independent climate models are required to represent modeling
@@ -86,8 +78,8 @@ linear increase in the rate of greenhouse gas emissions. SSP5-8.5 is at
 the high end of the baseline scenarios, representing rapid expansion of
 greenhouse gas emissions over the next several decades and
 end-of-century emissions more than three times higher than current
-emissions [Riahi et al.
-2017](https://www.sciencedirect.com/science/article/pii/S0959378016300681).
+emissions [(Riahi et al.
+2017)](https://www.sciencedirect.com/science/article/pii/S0959378016300681).
 
 Collectively, SSP1-2.6, SSP2-4.5, and SSP3-7.0 provide a reasonable
 representation of optimistic, neutral, and pessimistic outlooks on