R/xml_root.R

In SwissTPH/r-openMalariaUtilities: Helper functions to provide easier usage of Open Malaria from R

### Create document root

## Generate the xml root according to openMalara specs.

##' @title Generate XML root
##' @param schemaVersion OM schema version
##' @param name Experiment name
##' @param analysisNo Analysis number
##' @keywords internal
.makeXmlRoot <- function(schemaVersion, name, analysisNo) {
  ## Input verification
  assertCol <- checkmate::makeAssertCollection()
  checkmate::assertInteger(schemaVersion, add = assertCol)
  checkmate::assertCharacter(name, add = assertCol)
  checkmate::assertInteger(
    analysisNo,
    lower = 1L, upper = 100000000L, null.ok = TRUE, add = assertCol
  )
  checkmate::reportAssertions(collection = assertCol)

  ## Create root
  scenario <- xml2::xml_new_root(
    "om:scenario",
    "xmlns:om" = paste0(
      "http://openmalaria.org/schema/scenario_",
      schemaVersion
    ),
    "xmlns:xsi" = "http://www.w3.org/2001/XMLSchema-instance",
    "name" = name,
    "schemaVersion" = schemaVersion,
    "xsi:schemaLocation" = paste0(
      "http://openmalaria.org/schema/scenario_",
      schemaVersion,
      " ", "scenario_", schemaVersion, ".xsd"
    )
  )
  ## Add optional scenario attributes
  xml2::xml_set_attr(
    scenario,
    "analysisNo", analysisNo
  )
  ## Return root scenario
  return(scenario)
}