Download example USMs

Source: R/download_data.R

Download locally the example data from the data repository in the SticsRPacks organisation.

download_data(
  out_dir = tempdir(),
  example_dirs = NULL,
  stics_version = "latest",
  dir = lifecycle::deprecated(),
  version_name = lifecycle::deprecated()
)

Arguments

out_dir

Path of the directory where to download the data

example_dirs

List of use case directories names (optional)

stics_version

Name of the STICS version. Optional, by default the latest version returned by get_stics_versions_compat() is used.

dir

[Deprecated] dir is no longer supported, use out_dir instead.

version_name

[Deprecated] file_path is no longer supported, use file instead.

Value

The path to the folder where data have been downloaded

Examples


# Getting data for a given example : study_case_1 and a given STICS version
download_data(example_dirs = "study_case_1", stics_version = "V9.0")
#> [1] "/private/var/folders/n2/pt_35rc53tdgkld9531s2tfh0000gn/T/Rtmp7KS4Yk/data-master/study_case_1/V9.0"