gen_usms_xml: Generate STICS usms xml file from a template or an input file

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

Generate STICS usms xml file from a template or an input file

Description

Generate STICS usms xml file from a template or an input file

Usage

gen_usms_xml(
  file,
  param_df = NULL,
  template = NULL,
  stics_version = "latest",
  usms_out_file = lifecycle::deprecated(),
  usms_nb = lifecycle::deprecated(),
  usms_param = lifecycle::deprecated(),
  usms_in_file = lifecycle::deprecated()
)

Arguments

file	Path (including name) of the usms file to generate.
param_df	A table (df, tibble) containing the values of the parameters to use (see details)
template	Path of an USM xml file to be used as a template. Optional, if not provided, the function will use a standard template depending on the STICS version.
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.
usms_out_file	usms_out_file is no longer supported, use file instead.
usms_nb	usms_nb is no longer supported, use NA instead.
usms_param	usms_param is no longer supported, use param_df instead.
usms_in_file	usms_in_file is no longer supported, use template 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:

usm_name	datedebut	datefin	nomsol
USM_2017_T1_CI	199	263	USM_T1
USM_2018_T1	264	570	USM_T1
BIN_CANPC_05_SEC_220-0-0_34K_CANPC05T3_Q	199	263	LF1
BIN_AGT_04_IRR_220-0-0_33K_AGT04T2_Q	264	570	LF1
AGA_ARB_13_IRR_220-0-0_37K_ARB13_C	199	263	F1
AGA_ARB_13_SEC_220-0-0_37K_ARB13_C	264	570	LF1
FRA_ARB_11_SEC_220-0-0_38K_E	199	263	LF1
MAG_ARB_09_SEC_220-0-0_38K_E	264	570	LF1
MAG_ARV_12_IRR_220-0-0_36K_ARV12_C	199	263	LF1
MAG_ARV_12_SEC_220-0-0_36K_ARV12_C	264	570	LF1
FRA_ARB_12_SEC_220-0-0_31K_ARB12_C	199	263	LF1
FRA_ARB_13_SEC_220-0-0_37K_ARB13_C	264	570	LF1

The first column gives the usm name, all following columns give the parameter values to put in the usms.xml file for each usm row.

The first column name must contain the keyword Usm or usm or USM 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

an invisible xml_document object

Examples

xl_path <- download_usm_xl(file = "inputs_stics_example.xlsx")
usms_param_df <- read_params_table(file = xl_path, sheet_name = "USMs")
gen_usms_xml(file = file.path(tempdir(), "usms.xml"),
 param_df = usms_param_df)

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