download_usm_xl: Downloading an Excel usms data file example into a directory

In SticsRFiles: Read and Modify 'STICS' Input/Output Files

Downloading an Excel usms data file example into a directory

Description

The file is an example that can be used for generating JavaSTICS input files from parameters values stored in Excel spreadsheet format (USMs, Ini, Soils, Tec, Station, ...). Each sheet contains parameters values to insert into XML files, with the help of these functions: gen_usms_xml, gen_sols_xml, gen_tec_xml, gen_sta_xml, gen_usms_xml, gen_ini_xml

Usage

download_usm_xl(
  file = NULL,
  out_dir = tempdir(),
  stics_version = "latest",
  overwrite = FALSE,
  verbose = FALSE,
  xl_name = lifecycle::deprecated(),
  version_name = lifecycle::deprecated(),
  dest_dir = lifecycle::deprecated(),
  ...
)

Arguments

file	Name of an Excel file (optional, not used for the moment)
out_dir	Directory path where to copy the Excel file (optional, default: tempdir())
stics_version	Name of the STICS version. Optional, by default the latest version returned by get_stics_versions_compat() is used.
overwrite	Optional logical, TRUE for overwriting files, FALSE otherwise (default)
verbose	Logical value for displaying information while running
xl_name	xl_name is no longer supported, use file instead.
version_name	version_name is no longer supported, use stics_version instead.
dest_dir	dest_dir is no longer supported, use out_dir instead.
...	Additional arguments to be passed

Value

A vector of copied files path.

Examples

download_usm_xl()

SticsRFiles documentation built on Sept. 12, 2024, 7:41 a.m.