Setting parameter values into xml files

Source: R/set_param_xml.R

Setting parameter values for a parameter or a vector of and with a parameters values vector

set_param_xml(
  file,
  param,
  values,
  save_as = NULL,
  select = NULL,
  select_value = NULL,
  overwrite = FALSE,
  xml_file = lifecycle::deprecated(),
  out_path = lifecycle::deprecated(),
  param_name = lifecycle::deprecated(),
  param_value = lifecycle::deprecated(),
  value = lifecycle::deprecated(),
  ...
)

Arguments

file

Path (including name) of the xml file to modify

param

Vector of parameter names.

values

A vector or a list of parameter(s) values (see details).

save_as

Path (including name) of the xml file to generate. Optional, if NULL file is overwritten.

select

node name or attribute name to use for selection (optional, default to no selection)

select_value

Vector of values used for select (see examples). Optional, should be provided only if select is provided.

overwrite

Logical TRUE for overwriting the output file, FALSE otherwise (default)

xml_file

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

out_path

[Deprecated] out_path is no longer supported, use save_as instead.

param_name

[Deprecated] param_name is no longer supported, use param instead.

param_value

[Deprecated] param_value is no longer supported, use values instead.

value

[Deprecated] value is no longer supported, use select_value instead.

...

Pass further arguments to set_param_value().

Value

A logical value TRUE for operation success, FALSE otherwise

Details

It is possible to give several values for a parameter by passing a vector of values. For example, for two parameters with two values each: value= list(c(1,2), c(2.3,4.5))

Examples


ex_path <- get_examples_path(file_type = "xml")

# Soil file

sol_path <- file.path(ex_path, "sols.xml")

# For scalar parameters per soil
# Setting all soils "argi" values to 50
set_param_xml(sol_path, "argi", 50, overwrite = TRUE)
# Getting changed values
# get_param_xml(sol_path, "argi")

# Setting a specific value to "argi" for "solcanne" soil
set_param_xml(file = sol_path, param = "argi", values = 56,
   select = "sol", select_value = "solcanne", overwrite = TRUE
)
# Getting changed values
# get_param_xml(sol_path, "argi",
#   select = "sol", select_value = "solcanne"
#)


# Setting a specific values to 2 parameters "argi" and
# "norg" for "solcanne" soil
set_param_xml(sol_path, c("argi", "norg"), list(100, 150),
  select = "sol", select_value = "solcanne", overwrite = TRUE
)
# Getting changed values
# get_param_xml(sol_path, c("argi", "norg"),
#   select = "sol", select_value = "solcanne"
#)


# For vector parameters per soil (5 values, one per soil layer)
set_param_xml(sol_path, c("epc", "HCCF"),
  select = "sol",
  select_value = c("solcanne", "solbanane"),
  param_value = list(c(20:24, 10:14), c(50:54, 40:44)), overwrite = TRUE
)
#> Warning: The `param_value` argument of `set_param_xml()` is deprecated as of SticsRFiles
#> 1.0.0.
#> ℹ Please use the `values` argument instead.
# Getting changed values
# get_param_xml(sol_path, c("epc", "HCCF"),
# select = "sol",
# select_value = c("solcanne", "solbanane")
# )


# Crop management file

tec_path <- file.path(ex_path, "file_tec.xml")

# Modifying irrigations parameters
set_param_xml(tec_path, c("julapI_or_sum_upvt", "amount"),
  param_value = list(200:215, 20:35), overwrite = TRUE
)
# Getting changed values
# get_param_xml(tec_path, c("julapI_or_sum_upvt", "amount"))