get_usms_list: Getting usms names list for an usms.xml file

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

Getting usms names list for an usms.xml file

Description

Extracting a usm names list from an usms.xml file

Usage

get_usms_list(
  file,
  usm = NULL,
  usm_path = lifecycle::deprecated(),
  name = lifecycle::deprecated()
)

Arguments

file	Path (including name) of the USM xml file
usm	Vector of USM names (or partial names). Optional, if not provided, the function returns the names of all the USMs included in the given file.
usm_path	usm_path is no longer supported, use file instead.
name	name is no longer supported, use usm instead.

Value

A vector of usm names

Examples

path <- get_examples_path(file_type = "xml")

usms_list <- get_usms_list(file = file.path(path, "usms.xml"))

usms_list <- get_usms_list(file = file.path(path, "usms.xml"),
usm = c("usm1", "usm2"))

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