polish documentation

DESCRIPTION

@@ -8,7 +8,7 @@ Authors@R:
 Description: Provides functions that automate downloading and importing
     University of East Anglia Climate Research Unit ('CRU') 'CL' v. 2.0
     climatology data, facilitates the calculation of minimum temperature
-    and maximum temperature and formats the data into a data frame or a
+    and maximum temperature and formats the data into a data.table object or a
     list of 'terra' 'rast' objects for use.  'CRU' 'CL' v. 2.0 data are a
     gridded climatology of 1961-1990 monthly means released in 2002 and
     cover all land areas (excluding Antarctica) at 10 arc minutes

R/create_CRU_df.R

@@ -1,9 +1,9 @@
 #' Create a data.table of Climatology Variables From Local Disk Files
 #'
 #' Automates importing \acronym{CRU} \acronym{CL} v.2.0 climatology
-#' data and creates a tidy data frame 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
+#' 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.
 #'

codemeta.json

@@ -2,7 +2,7 @@
   "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
   "@type": "SoftwareSourceCode",
   "identifier": "getCRUCLdata",
-  "description": "Provides functions that automate downloading and importing University of East Anglia Climate Research Unit ('CRU') 'CL' v. 2.0 climatology data, facilitates the calculation of minimum temperature and maximum temperature and formats the data into a data frame or a list of 'terra' 'rast' objects for use. 'CRU' 'CL' v. 2.0 data are a gridded climatology of 1961-1990 monthly means released in 2002 and cover all land areas (excluding Antarctica) at 10 arc minutes (0.1666667 degree) resolution. For more information see the description of the data provided by the University of East Anglia Climate Research Unit, <https://crudata.uea.ac.uk/cru/data/hrg/tmc/readme.txt>.",
+  "description": "Provides functions that automate downloading and importing University of East Anglia Climate Research Unit ('CRU') 'CL' v. 2.0 climatology data, facilitates the calculation of minimum temperature and maximum temperature and formats the data into a data.table object or a list of 'terra' 'rast' objects for use. 'CRU' 'CL' v. 2.0 data are a gridded climatology of 1961-1990 monthly means released in 2002 and cover all land areas (excluding Antarctica) at 10 arc minutes (0.1666667 degree) resolution. For more information see the description of the data provided by the University of East Anglia Climate Research Unit, <https://crudata.uea.ac.uk/cru/data/hrg/tmc/readme.txt>.",
   "name": "getCRUCLdata: 'CRU' 'CL' v. 2.0 Climatology Client",
   "relatedLink": "https://docs.ropensci.org/getCRUCLdata/",
   "codeRepository": "https://github.com/ropensci/getCRUCLdata",
@@ -244,7 +244,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": "910.679KB",
+  "fileSize": "910.693KB",
   "citation": [
     {
       "@type": "ScholarlyArticle",

vignettes/Advanced_use.Rmd

@@ -19,8 +19,7 @@ knitr::opts_chunk$set(
 ## Caching files for later use
 
 When using the `get_CRU_df()` or `get_CRU_stack()` functions, files may be cached in the users' local space for later use (optional) or stored in a temporary directory and deleted when the R session is closed and not saved (this is the default behaviour already illustrated above).
-Illustrated here, create a tidy data frame of all CRU CL v. 2.0 climatology elements available and cache
-them to save time in the future.
+Illustrated here, create a data.table of all CRU CL v. 2.0 climatology elements available and cache them to save time in the future.
 *In order to take advantage of the cached data, you must use the `get_CRU_df()` function again in the future*.
 This functionality is somewhat modelled after the raster package's `raster::getData()` that will not download files that already exist in the working directory, however in this case the function is portable and it will work for any working directory.
 That is, if you have cached the data and you use `get_CRU_df()` again, it will use the cached data no matter what working directory you are in.