A function to parse the future climate from worldclim version 2.1.
Source:R/future_worldclim2.R
future_worldclim2.Rd
This function allows you to parse worldclim version 2.1 future climatic files with a setting of boundary and a few other options.
Usage
future_worldclim2(
var = "tmin",
res = 10,
gcm = "BCC-CSM2-MR",
ssp = "ssp585",
interval = "2021-2040",
bry = NULL,
path = NULL,
nm_mark = "clip",
return_stack = TRUE
)
Arguments
- var
(
character
) The option for the variable to download. Should be one of tmin, tmax, prec, bioc. The default is tmin.- res
(
numeric
) The option for the resolution of image to download. Should be one of 0.5, 2.5, 5, 10. The default is 10.- gcm
(
character
) The option for global climate models. Check https://www.worldclim.org for all available GCM.- ssp
(
character
) The option for Shared Socio-economic Pathways. Should be one of "ssp126", "ssp245", "ssp370", "ssp585". The default is "ssp585".- interval
(
character
) The option for time interval. Should be one of "2021-2040", "2041-2060", "2061-2080", "2081-2100". The default is "2021-2040".- bry
(
sf
) The boundary to mask the downloaded original data. IfNULL
, it would get global map. If notNULL
, it can takesf
,sfc
, etc. The default isNULL
.- path
(
character
) The path to save the downloaded imagery. IfNULL
, it would use the current working directory. The default isNULL
.- nm_mark
(
character
) the name mark of clipped images. The default is "clip". It would be ignored ifbry
isNULL
.- return_stack
(
logical
) ifTRUE
, stack the imagery together and return. If the area is large and resolution is high, it is better not to stack them. The default isTRUE
.
Value
if return_stack
is TRUE
, the images would be
returned as a stars
. Otherwise, nothing to return, but the user
would receive a message of where the images are.
Note
If it fails due to slow internet, try to set a larger timeout option,
e.g., using options(timeout = 1e3)
.
References
Fick, Stephen E., and Robert J. Hijmans. "WorldClim 2: new 1-km spatial resolution climate surfaces for global land areas." International journal of climatology 37.12 (2017): 4302-4315.doi:10.1002/joc.5086
Examples
if (FALSE) { # \dontrun{
future_worldclim2("tmin", 10, "BCC-CSM2-MR",
"ssp585", "2021-2040",
path = tempdir(), return_stack = FALSE)
} # }