R/epw.R
download_weather.Rd
download_weather()
makes it easy to download EnergyPlus weather files (EPW)
and design day files (DDY).
download_weather(
pattern,
filename = NULL,
dir = ".",
type = c("all", "epw", "ddy", "stat"),
ask = TRUE,
max_match = 3
)
A regular expression used to search locations, e.g. "los angeles.*tmy3"
. The search is case-insensitive.
File names (without extension) used to save downloaded files.
Internally, make.unique()
is called to ensure unique names.
Directory to save downloaded files. Will create if not exist.
File type to download. Only applicable to data provided by
EnergyPlus website. For OneBuilding.org, "all"
will always be used.
Should be one of "all"
, "epw"
, "ddy"
and "stat"
. If "all"
, all
weather data will be downloaded in a ZIP file. Default: "all"
.
If TRUE
, a command line menu will be shown to let you select
which one to download. If FALSE
and the number of returned results is
less than max_match
, files are downloaded automatically without asking.
The max results allowed to download when ask
is FALSE
.
A character vector containing paths of downloaded files.
There are 2 data sources:
EnergyPlus sources allow downloading EPW, STAT, and DDY files separately while OneBuilding sources can only download them all through a ZIP file.
if (FALSE) { # \dontrun{
download_weather("los angeles.*tmy3", "LosAngeles", tempdir(), ask = FALSE)
} # }