Converts Luminescence::RLum objects to XLUM format.
Arguments
- rlum
Luminescence::RLum or a list of it (required): input object.
- out_file
character (optional): path to an output file where the XLUM file should be written to. If
NULL(default), no file is written, but an xml2::xml_document object is returned.
Value
When out_file is NULL (default), an xml2::xml_document object
is returned. Otherwise the document is written to out_file (with the .xlum
extension added automatically if needed) and NULL is returned invisibly.
Details
The function tries to make the best possible conversion of an Luminescence::RLum object to the XLUM format. Supported are Luminescence::RLum.Analysis objects as well as the Luminescence::RLum.Data objects they may contain. Luminescence::RLum.Results objects are not supported.
The input may be a single object or a list of objects. All objects in a
list must be of the same class, either Luminescence::RLum.Analysis
or Luminescence::RLum.Data. A list of data
objects is combined into a single sequence, whereas a list of
Luminescence::RLum.Analysis objects produces one <sequence/> per
element.
Each analysis record is mapped to a <record/> node holding one or more
<curve/> nodes. The measured values are stored as the text content of the
<curve/> node, while tValues, xValues, and yValues are kept as node
attributes. Additional record attributes, such as curveType and
startDate, are transferred where available.
As Luminescence::RLum objects do not distinguish between different
samples, the <xlum/> and <sample/> nodes are created automatically, so
all converted objects end up in a single sample.
Author
Sebastian Kreutzer, F2.1 Geophysical Parametrisation/Regionalisation, LIAG - Institute for Applied Geophysics (Germany)
Examples
## load example data
data(ExampleData.RLum.Analysis, envir = environment(), package = "Luminescence")
## convert to an in-memory XLUM document
xlum <- convert_rlum2xlum(IRSAR.RF.Data)
## convert and write to a file
convert_rlum2xlum(IRSAR.RF.Data, tempfile(fileext = ".xlum"))