gen_ini_xml: Generate STICS ini xml file(s) from a template or an input...

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

Generate STICS ini xml file(s) from a template or an input file

Description

Generate STICS ini xml file(s) from a template or an input file

Usage

gen_ini_xml(
  param_df,
  file = NULL,
  out_dir,
  crop_tag = "Crop",
  stics_version = "latest",
  ini_in_file = lifecycle::deprecated(),
  param_table = lifecycle::deprecated(),
  out_path = lifecycle::deprecated()
)

Arguments

param_df	A table (df, tibble) containing the values of the parameters to use (see details)
file	Path of an ini xml file to be used as a template. Optional, if not provided, the function will use a standard template depending on the STICS version (see stics_version argument)
out_dir	Path of the directory where to generate the file(s).
crop_tag	identifier for the crop parameters names related to the main crop, or the associated crop if any (example: Crop is used in the param_table example in the details section below)
stics_version	Name of the STICS version. Optional, used if the file argument is not provided. In this case the function uses a standard template associated to the STICS version.
ini_in_file	ini_in_file is no longer supported, use file instead.
param_table	param_table is no longer supported, use param_df instead.
out_path	out_path is no longer supported, use out_dir instead.

Details

Please see get_stics_versions_compat() for the full list of STICS versions that can be used for the argument stics_version.

param_df is a data.frame with the following format:

Ini_name	nbplantes	stade0_Crop1	lai0_Crop1	masec0_Crop1
USM_2017_T1_ini.xml	1	snu	0	0
Vill09_ini.xml	1	snu	0	0
Vill10_ini.xml	1	snu	0	0
Vill11_ini.xml	1	snu	0	0
Vill12_ini.xml	1	snu	0	0
Vill13_ini.xml	1	snu	0	0
Vill14_ini.xml	1	snu	0	0
Standard_ini.xml	1	snu	0	0

The first column gives the ini file name (to be generated), all following columns give the parameter value to put in the file, and each line denotes a separate ini file (for e.g. several USMs).

The first column name must contain the keyword ini or Ini or INI as a prefix to be detected (as shown in the table extract above).

If not given (the default, NULL), the function returns the template as is.

Value

None

Examples

library(readxl)

xl_path <- download_usm_xl(file = "inputs_stics_example.xlsx")

ini_param_df <- read_excel(xl_path, sheet = "Ini")
gen_ini_xml(
  out_dir = tempdir(),
  param_df = ini_param_df[1:2,]
)

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