Package 'getCRUCLdata'

Title: 'CRU' 'CL' v. 2.0 Climatology Client
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>.
Authors: Adam H. Sparks [aut, cre] , Curtin University of Technology [cph] (Provided support through Adam Sparks's time.), Grains Research and Development Corporation [cph] (GRDC Project CUR2210-005OPX (AAGI-CU))
Maintainer: Adam H. Sparks <[email protected]>
License: MIT + file LICENSE
Version: 1.0.2
Built: 2025-01-17 03:52:51 UTC
Source: https://github.com/ropensci/getCRUCLdata

Help Index


Create a data.table of CRU CL v. 2.0 climatology elements from local disk files

Description

Automates importing CRU CL v.2.0 climatology data and creates a 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 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.

Usage

create_CRU_df(
  pre = FALSE,
  pre_cv = FALSE,
  rd0 = FALSE,
  tmp = FALSE,
  dtr = FALSE,
  reh = FALSE,
  tmn = FALSE,
  tmx = FALSE,
  sunp = FALSE,
  frs = FALSE,
  wnd = FALSE,
  elv = FALSE,
  dsn
)

create_cru_df(
  pre = FALSE,
  pre_cv = FALSE,
  rd0 = FALSE,
  tmp = FALSE,
  dtr = FALSE,
  reh = FALSE,
  tmn = FALSE,
  tmx = FALSE,
  sunp = FALSE,
  frs = FALSE,
  wnd = FALSE,
  elv = FALSE,
  dsn
)

Arguments

pre

Loads precipitation (millimetres/month) from server and returns in the data frame, TRUE. Defaults to FALSE.

pre_cv

Loads cv of precipitation (percent) from server and returns in the data frame, TRUE. Defaults to FALSE. NOTE. Setting this to TRUE will always results in pre being set to TRUE and returned as well.

rd0

Loads wet-days (number days with >0.1 millimetres rain per month) and returns in the data frame, TRUE. Defaults to FALSE.

tmp

Loads temperature (degrees Celsius) and returns it in the data frame, TRUE. Defaults to FALSE.

dtr

Loads mean diurnal temperature range (degrees Celsius) and returns it in the data frame, TRUE. Defaults to FALSE.

reh

Loads relative humidity and returns it in the data frame, TRUE. Defaults to FALSE.

tmn

Calculate minimum temperature values (degrees Celsius) and returns it in the data frame, TRUE. Defaults to FALSE.

tmx

Calculate maximum temperature (degrees Celsius) and return it in the data frame, TRUE. Defaults to FALSE.

sunp

Loads sunshine, percent of maximum possible (percent of day length) and returns it in the data frame, TRUE. Defaults to FALSE.

frs

Loads ground-frost records (number of days with ground- frost per month) and returns it in the data frame, TRUE. Defaults to FALSE.

wnd

Load 10 m wind speed (metres/second) and returns it in the data frame, TRUE. Defaults to FALSE.

elv

Loads elevation (converted to metres) and returns it in the data frame, TRUE. Defaults to FALSE.

dsn

Local file path where CRU CL v.2.0 .dat.gz files are located.

Value

A data.table::data.table object of CRU CL v. 2.0 climatology elements.

Nomenclature and Units

pre

precipitation (millimetres/month)

cv

cv of precipitation (percent)

rd0

wet-days (number days with >0.1 millimetres rain per month)

tmp

mean temperature (degrees Celsius)

dtr

mean diurnal temperature range (degrees Celsius)

reh

relative humidity (percent)

sunp

sunshine (percent of maximum possible (percent of day length))

frs

ground-frost (number of days with ground-frost per month)

wnd

10 metre windspeed (metres/second)

elv

elevation (automatically converted to metres)

For more information see the description of the data provided by CRU, https://crudata.uea.ac.uk/cru/data/hrg/tmc/readme.txt

Author(s)

Adam H. Sparks, [email protected]

Source

pre

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_pre.dat.gz

rd0

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_rd0.dat.gz

tmp

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_tmp.dat.gz

dtr

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_dtr.dat.gz

reh

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_reh.dat.gz

sunp

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_sunp.dat.gz

frs

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_frs.dat.gz

wnd

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_wnd.dat.gz, areas originally including Antarctica are removed.

elv

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_elv.dat.gz, values are converted from kilometres to metres.

This package crops all spatial outputs to an extent of ymin = -60, ymax = 85, xmin = -180, xmax = 180.

References

New, Mark, et al. "A high-resolution data set of surface climate over global land areas." Climate research 21.1 (2002): 1-25. https://crudata.uea.ac.uk/cru/data/hrg/tmc/new_et_al_10minute_climate_CR.pdf

See Also

get_CRU_df.

Examples

# Create a data frame of temperature from locally available files in the
# tempdir() directory.

download.file(
  url = "https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_tmp.dat.gz",
  destfile = file.path(tempdir(), "grid_10min_tmp.dat.gz")
)

CRU_tmp <- create_CRU_df(tmp = TRUE, dsn = tempdir())

CRU_tmp

Create a list of terra rast objects of CRU CL v. 2.0 climatology elements from local disk files

Description

Automates importing CRU CL v.2.0 climatology data and creates a 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. 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.

Usage

create_CRU_stack(
  pre = FALSE,
  pre_cv = FALSE,
  rd0 = FALSE,
  tmp = FALSE,
  dtr = FALSE,
  reh = FALSE,
  tmn = FALSE,
  tmx = FALSE,
  sunp = FALSE,
  frs = FALSE,
  wnd = FALSE,
  elv = FALSE,
  dsn
)

create_cru_stack(
  pre = FALSE,
  pre_cv = FALSE,
  rd0 = FALSE,
  tmp = FALSE,
  dtr = FALSE,
  reh = FALSE,
  tmn = FALSE,
  tmx = FALSE,
  sunp = FALSE,
  frs = FALSE,
  wnd = FALSE,
  elv = FALSE,
  dsn
)

Arguments

pre

Loads precipitation (millimetres/month) from server and returns in the data frame, TRUE. Defaults to FALSE.

pre_cv

Loads cv of precipitation (percent) from server and returns in the data frame, TRUE. Defaults to FALSE. NOTE. Setting this to TRUE will always results in pre being set to TRUE and returned as well.

rd0

Loads wet-days (number days with >0.1 millimetres rain per month) and returns in the data frame, TRUE. Defaults to FALSE.

tmp

Loads temperature (degrees Celsius) and returns it in the data frame, TRUE. Defaults to FALSE.

dtr

Loads mean diurnal temperature range (degrees Celsius) and returns it in the data frame, TRUE. Defaults to FALSE.

reh

Loads relative humidity and returns it in the data frame, TRUE. Defaults to FALSE.

tmn

Calculate minimum temperature values (degrees Celsius) and returns it in the data frame, TRUE. Defaults to FALSE.

tmx

Calculate maximum temperature (degrees Celsius) and return it in the data frame, TRUE. Defaults to FALSE.

sunp

Loads sunshine, percent of maximum possible (percent of day length) and returns it in the data frame, TRUE. Defaults to FALSE.

frs

Loads ground-frost records (number of days with ground- frost per month) and returns it in the data frame, TRUE. Defaults to FALSE.

wnd

Load 10 m wind speed (metres/second) and returns it in the data frame, TRUE. Defaults to FALSE.

elv

Loads elevation (converted to metres) and returns it in the data frame, TRUE. Defaults to FALSE.

dsn

Local file path where CRU CL v.2.0 .dat.gz files are located.

Value

A base::list of terra::rast objects of CRU CL v. 2.0 climatology elements.

Nomenclature and Units

pre

precipitation (millimetres/month)

cv

cv of precipitation (percent)

rd0

wet-days (number days with >0.1 millimetres rain per month)

tmp

mean temperature (degrees Celsius)

dtr

mean diurnal temperature range (degrees Celsius)

reh

relative humidity (percent)

sunp

sunshine (percent of maximum possible (percent of day length))

frs

ground-frost (number of days with ground-frost per month)

wnd

10 metre windspeed (metres/second)

elv

elevation (automatically converted to metres)

For more information see the description of the data provided by CRU, https://crudata.uea.ac.uk/cru/data/hrg/tmc/readme.txt

Author(s)

Adam H. Sparks, [email protected]

Source

pre

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_pre.dat.gz

rd0

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_rd0.dat.gz

tmp

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_tmp.dat.gz

dtr

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_dtr.dat.gz

reh

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_reh.dat.gz

sunp

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_sunp.dat.gz

frs

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_frs.dat.gz

wnd

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_wnd.dat.gz, areas originally including Antarctica are removed.

elv

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_elv.dat.gz, values are converted from kilometres to metres.

This package crops all spatial outputs to an extent of ymin = -60, ymax = 85, xmin = -180, xmax = 180.

References

New, Mark, et al. "A high-resolution data set of surface climate over global land areas." Climate research 21.1 (2002): 1-25. https://crudata.uea.ac.uk/cru/data/hrg/tmc/new_et_al_10minute_climate_CR.pdf

See Also

get_CRU_stack.

Examples

download.file(
  url = "https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_tmp.dat.gz",
  destfile = file.path(tempdir(), "grid_10min_tmp.dat.gz")
)

CRU_tmp <- create_CRU_stack(tmp = TRUE, dsn = tempdir())

CRU_tmp

Download and create a data.table of CRU CL v. 2.0 climatology elements

Description

This function automates downloading and importing CRU CL v. 2.0 climatology data and creates a 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.

Usage

get_CRU_df(
  pre = FALSE,
  pre_cv = FALSE,
  rd0 = FALSE,
  tmp = FALSE,
  dtr = FALSE,
  reh = FALSE,
  tmn = FALSE,
  tmx = FALSE,
  sunp = FALSE,
  frs = FALSE,
  wnd = FALSE,
  elv = FALSE,
  cache = FALSE
)

get_cru_df(
  pre = FALSE,
  pre_cv = FALSE,
  rd0 = FALSE,
  tmp = FALSE,
  dtr = FALSE,
  reh = FALSE,
  tmn = FALSE,
  tmx = FALSE,
  sunp = FALSE,
  frs = FALSE,
  wnd = FALSE,
  elv = FALSE,
  cache = FALSE
)

Arguments

pre

Fetches precipitation (millimetres/month) from server and returns it in the data frame, TRUE. Defaults to FALSE.

pre_cv

Fetch cv of precipitation (percent) from server and returns it in the data frame, TRUE. Defaults to FALSE. NOTE Setting this to TRUE will always results in pre being set to TRUE and returned as well.

rd0

Fetches wet-days (number days with >0.1 millimetres rain per month) and returns it in the data frame? Defaults to FALSE.

tmp

Fetches temperature (degrees Celsius) and returns it in the data frame, TRUE. Defaults to FALSE.

dtr

Fetches mean diurnal temperature range (degrees Celsius) and returns it in the data frame? Defaults to FALSE.

reh

Fetches relative humidity and returns it in the data frame, TRUE. Defaults to FALSE.

tmn

Calculates minimum temperature values (degrees Celsius) and returns it in the data frame, TRUE. Defaults to FALSE.

tmx

Calculates maximum temperature (degrees Celsius) and returns it in the data frame, TRUE. Defaults to FALSE.

sunp

Fetch sunshine, percent of maximum possible (percent of day length) and return it in the data frame? Defaults to FALSE.

frs

Fetches ground-frost records (number of days with ground- frost per month) and return it in the data frame? Defaults to FALSE.

wnd

Fetches 10m wind speed (metres/second) and returns it in the data frame, TRUE. Defaults to FALSE.

elv

Fetches elevation (converted to metres) and returns it in the data frame, TRUE. Defaults to FALSE.

cache

Stores CRU CL v. 2.0 data files locally for later use. If FALSE, the downloaded files are removed when the R session is closed. To take advantage of cached files in future sessions, use cache = TRUE even after the initial download and caching. Defaults to FALSE.

Value

A data.table::data.table object of CRU CL v. 2.0 climatology elements.

Nomenclature and Units

pre

precipitation (millimetres/month)

cv

cv of precipitation (percent)

rd0

wet-days (number days with >0.1 millimetres rain per month)

tmp

mean temperature (degrees Celsius)

dtr

mean diurnal temperature range (degrees Celsius)

reh

relative humidity (percent)

sunp

sunshine (percent of maximum possible (percent of day length))

frs

ground-frost (number of days with ground-frost per month)

wnd

10 metre windspeed (metres/second)

elv

elevation (automatically converted to metres)

For more information see the description of the data provided by CRU, https://crudata.uea.ac.uk/cru/data/hrg/tmc/readme.txt

Author(s)

Adam H. Sparks, [email protected]

Source

pre

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_pre.dat.gz

rd0

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_rd0.dat.gz

tmp

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_tmp.dat.gz

dtr

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_dtr.dat.gz

reh

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_reh.dat.gz

sunp

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_sunp.dat.gz

frs

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_frs.dat.gz

wnd

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_wnd.dat.gz, areas originally including Antarctica are removed.

elv

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_elv.dat.gz, values are converted from kilometres to metres.

This package crops all spatial outputs to an extent of ymin = -60, ymax = 85, xmin = -180, xmax = 180.

References

New, Mark, et al. "A high-resolution data set of surface climate over global land areas." Climate research 21.1 (2002): 1-25. https://crudata.uea.ac.uk/cru/data/hrg/tmc/new_et_al_10minute_climate_CR.pdf

See Also

create_CRU_stack, manage_cache.

Examples

# Download data and create a data frame of precipitation and temperature
# without caching the data files
CRU_pre_tmp <- get_CRU_df(pre = TRUE, tmp = TRUE)

head(CRU_pre_tmp)
CRU_pre_tmp

Download and create a list of terra rast objects of CRU CL v. 2.0 climatology elements

Description

This function automates downloading and importing CRU CL v. 2.0 climatology data into R and creates a list of 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.

Usage

get_CRU_stack(
  pre = FALSE,
  pre_cv = FALSE,
  rd0 = FALSE,
  tmp = FALSE,
  dtr = FALSE,
  reh = FALSE,
  tmn = FALSE,
  tmx = FALSE,
  sunp = FALSE,
  frs = FALSE,
  wnd = FALSE,
  elv = FALSE,
  cache = FALSE
)

get_cru_stack(
  pre = FALSE,
  pre_cv = FALSE,
  rd0 = FALSE,
  tmp = FALSE,
  dtr = FALSE,
  reh = FALSE,
  tmn = FALSE,
  tmx = FALSE,
  sunp = FALSE,
  frs = FALSE,
  wnd = FALSE,
  elv = FALSE,
  cache = FALSE
)

Arguments

pre

Fetches precipitation (millimetres/month) from server and returns it in the data frame, TRUE. Defaults to FALSE.

pre_cv

Fetch cv of precipitation (percent) from server and returns it in the data frame, TRUE. Defaults to FALSE. NOTE Setting this to TRUE will always results in pre being set to TRUE and returned as well.

rd0

Fetches wet-days (number days with >0.1 millimetres rain per month) and returns it in the data frame? Defaults to FALSE.

tmp

Fetches temperature (degrees Celsius) and returns it in the data frame, TRUE. Defaults to FALSE.

dtr

Fetches mean diurnal temperature range (degrees Celsius) and returns it in the data frame? Defaults to FALSE.

reh

Fetches relative humidity and returns it in the data frame, TRUE. Defaults to FALSE.

tmn

Calculates minimum temperature values (degrees Celsius) and returns it in the data frame, TRUE. Defaults to FALSE.

tmx

Calculates maximum temperature (degrees Celsius) and returns it in the data frame, TRUE. Defaults to FALSE.

sunp

Fetch sunshine, percent of maximum possible (percent of day length) and return it in the data frame? Defaults to FALSE.

frs

Fetches ground-frost records (number of days with ground- frost per month) and return it in the data frame? Defaults to FALSE.

wnd

Fetches 10m wind speed (metres/second) and returns it in the data frame, TRUE. Defaults to FALSE.

elv

Fetches elevation (converted to metres) and returns it in the data frame, TRUE. Defaults to FALSE.

cache

Stores CRU CL v. 2.0 data files locally for later use. If FALSE, the downloaded files are removed when the R session is closed. To take advantage of cached files in future sessions, use cache = TRUE even after the initial download and caching. Defaults to FALSE.

Value

A base::list of terra::rast objects of CRU CL v. 2.0 climatology elements.

Nomenclature and Units

pre

precipitation (millimetres/month)

cv

cv of precipitation (percent)

rd0

wet-days (number days with >0.1 millimetres rain per month)

tmp

mean temperature (degrees Celsius)

dtr

mean diurnal temperature range (degrees Celsius)

reh

relative humidity (percent)

sunp

sunshine (percent of maximum possible (percent of day length))

frs

ground-frost (number of days with ground-frost per month)

wnd

10 metre windspeed (metres/second)

elv

elevation (automatically converted to metres)

For more information see the description of the data provided by CRU, https://crudata.uea.ac.uk/cru/data/hrg/tmc/readme.txt

Author(s)

Adam H. Sparks, [email protected]

Source

pre

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_pre.dat.gz

rd0

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_rd0.dat.gz

tmp

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_tmp.dat.gz

dtr

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_dtr.dat.gz

reh

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_reh.dat.gz

sunp

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_sunp.dat.gz

frs

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_frs.dat.gz

wnd

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_wnd.dat.gz, areas originally including Antarctica are removed.

elv

https://crudata.uea.ac.uk/cru/data/hrg/tmc/grid_10min_elv.dat.gz, values are converted from kilometres to metres.

This package crops all spatial outputs to an extent of ymin = -60, ymax = 85, xmin = -180, xmax = 180.

References

New, Mark, et al. "A high-resolution data set of surface climate over global land areas." Climate research 21.1 (2002): 1-25. https://crudata.uea.ac.uk/cru/data/hrg/tmc/new_et_al_10minute_climate_CR.pdf

See Also

create_CRU_stack, manage_cache.

Examples

# Download data and create a list of {terra} `rast` objects of precipitation
# and temperature without caching the data files
CRU_pre_tmp <- get_CRU_stack(pre = TRUE, tmp = TRUE)

CRU_pre_tmp

Manage locally cached CRU CL v. 2.0 files

Description

Manage cached getCRUCLdata files with hoardr.

Details

The default cache directory is tools::R_user_dir(package = "getCRUCLdata"), but you can set your own path using manage_cache$cache_path_set().

manage_cache$cache_delete only accepts one file name, while manage_cache$cache_delete_all does not accept any names, but deletes all files. For deleting many specific files, use manage_cache$cache_delete in an base::lapply type call.

Useful user functions

manage_cache$cache_path_get()

get cache path

manage_cache$cache_path_set()

set cache path

manage_cache$list()

returns a character vector of full path file names

manage_cache$files()

returns file objects with metadata

manage_cache$details()

returns files with details

manage_cache$delete()

delete specific files

manage_cache$delete_all()

delete all files, returns nothing

Author(s)

Adam H. Sparks, [email protected]

Examples

## Not run: 

# list files in cache
manage_cache$list()

# delete certain database files
manage_cache$delete("file path")
manage_cache$list()

# delete all files in cache
manage_cache$delete_all()
manage_cache$list()

# set a different cache path from the default
manage_cache$cache_path_set("~/tmp")

## End(Not run)