Skip to content

Commit

Permalink
Provide a link to the CRU's readme.txt file for these data
Browse files Browse the repository at this point in the history
  • Loading branch information
adamhsparks committed Dec 17, 2024
1 parent 2b25a39 commit ef66ecb
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 25 deletions.
10 changes: 6 additions & 4 deletions R/create_CRU_df.R
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
#' Create a data.table of CRU CL v. 2.0 climatology elements from local disk files
#'
#' Automates importing \acronym{CRU} \acronym{CL} v.2.0 climatology
#' data and creates a \CRANpkg{data.table} of the data. If requested, minimum
#' data and creates a \CRANpkg{data.table} of the data. If requested, minimum
#' and maximum temperature may also be automatically calculated as described in
#' the data readme.txt file. This function can be useful if you have network
#' connection issues that mean automated downloading of the files using \R
#' does not work properly.
#' the data [readme.txt](https://crudata.uea.ac.uk/cru/data/hrg/tmc/readme.txt)
#' file. Data may be cached for later use by this function, saving time
#' downloading files in future using this function. This function can be useful
#' if you have network connection issues that mean automated downloading of the
#' files using \R does not work properly.
#'
#' @inheritSection get_CRU_df Nomenclature and Units
#'
Expand Down
9 changes: 6 additions & 3 deletions R/create_CRU_stack.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@
#' Automates importing \acronym{CRU} \acronym{CL} v.2.0 climatology
#' data and creates a \CRANpkg{terra} [terra::rast] object of the
#' data. If requested, minimum and maximum temperature may also be
#' automatically calculated as described in the data readme.txt file. This
#' function can be useful if you have network connection issues that mean
#' automated downloading of the files using \R does not work properly.
#' automatically calculated as described in the data
#' [readme.txt](https://crudata.uea.ac.uk/cru/data/hrg/tmc/readme.txt) file.
#' Data may be cached for later use by this function, saving time downloading
#' files in future using this function. This function can be useful if you have
#' network connection issues that mean automated downloading of the files using
#' \R does not work properly.
#'
#' @inheritSection get_CRU_df Nomenclature and Units
#' @inheritParams create_CRU_df
Expand Down
7 changes: 4 additions & 3 deletions R/get_CRU_df.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
#' This function automates downloading and importing \acronym{CRU}
#' \acronym{CL} v. 2.0 climatology data and creates a \CRANpkg{data.table} of
#' the data. If requested, minimum and maximum temperature may also be
#' automatically calculated as described in the data readme.txt file. Data may
#' be cached for later use by this function, saving time downloading files in
#' future use of this function.
#' automatically calculated as described in the data
#' [readme.txt](https://crudata.uea.ac.uk/cru/data/hrg/tmc/readme.txt) file.
#' Data may be cached for later use by this function, saving time downloading
#' files in future use of this function.
#'
#' @section Nomenclature and Units:
#' \describe{
Expand Down
5 changes: 3 additions & 2 deletions R/get_CRU_stack.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
#' climatology data into \R and creates a list of \CRANpkg{terra}
#' [terra::rast] objects of the data. If requested, minimum and maximum
#' temperature may also be automatically calculated as described in the data
#' readme.txt file. Data may be cached for later use by this function, saving
#' time downloading files in future using this function.
#' [readme.txt](https://crudata.uea.ac.uk/cru/data/hrg/tmc/readme.txt) file.
#' Data may be cached for later use by this function, saving time downloading
#' files in future using this function.
#'
#' @inheritSection get_CRU_df Nomenclature and Units
#' @inheritParams get_CRU_df
Expand Down
2 changes: 1 addition & 1 deletion codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@
"applicationCategory": "Tools",
"isPartOf": "https://ropensci.org",
"keywords": ["anglia-cru", "climate-data", "cru-cl2", "temperature", "rainfall", "elevation", "data-access", "wind", "relative-humidity", "solar-radiation", "diurnal-temperature", "frost", "cru", "r", "rstats", "r-package", "peer-reviewed"],
"fileSize": "920.717KB",
"fileSize": "921.658KB",
"citation": [
{
"@type": "ScholarlyArticle",
Expand Down
10 changes: 6 additions & 4 deletions man/create_CRU_df.Rd

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

9 changes: 6 additions & 3 deletions man/create_CRU_stack.Rd

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

7 changes: 4 additions & 3 deletions man/get_CRU_df.Rd

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

5 changes: 3 additions & 2 deletions man/get_CRU_stack.Rd

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

0 comments on commit ef66ecb

Please sign in to comment.