This function writes comma-separated files in a format compatible with
ProxiScout-related software, which typically require two separate comma-separated
files - one file for the spectra, and another file for reference values.
These files are created inside the specified directory (argument path).
proxiscout_write_data(x, path, file_prefix, properties = NULL, spc = "spc")A character with the paths to the created files.
a data.frame of spectral data for which to write the data files.
Typically, this is returned by proxiscout_read_data and of class
"proxiscout_data".
a character for the directory in which the files will be saved.
a character for the prefix of the generated files. The files
are then named as [file_prefix]_spectra.csv and [file_prefix]_properties.csv.
Default is proxiscout_export.
a vector of characters of arbitrary length. Which properties
in x are to be added to the csv? Default is NULL.
either a character or a vector of integers. Specifies where the
spectra can be found inside x. Default is "spc".
Leonardo Ramirez-Lopez, Claudio Orellano
This function creates up to two comma separated files in the directory path,
which are usable by ProxiScout-related software. These files are named according
to the file_prefix argument and contain the spectra together with the sample
names and device ID, respectively the reference values with the sample names.
Typically, the data provided to this function is imported with proxiscout_read_data
and of class "proxiscout_data", but it is also possible to construct a data.frame
by hand and provide it to this function.
The properties argument specifies which columns in x are the reference values
written to the [file_prefix]_properties.csv file. If empty (default), this
file is not created, as it would only contain sample names. Any row in the
provided properties that only contains NA values are dropped. In general,
NA values are set to an empty string ("")
The sample names are detected automatically from x as the column with a name
that contains "sample". If none are detected, the function will throw an
error. This column will be named "Sample Name" in the [file_prefix]_spectra.csv
file, and "sampleName" in the [file_prefix]_properties.csv file.
Similarly, the device ID is a required column and is identified as having a
"device" string inside the name of the column. This column is only written into
the [file_prefix]_spectra.csv file, with a fixed named "Device Id".
All other columns in either file only correspond to the spectra respectively
the reference values. In particular, other columns in x are dropped.