getmd: Get Metadata

In bpollner/aquap2: Multivariate Data Analysis Tools for R including Aquaphotomics Methods

Get Metadata

Description

Read in the metadata from the default or a custom metadata file located in the metadata-folder. By providing the argument 'expName' to the function you can override the experiment name as specified in the metadata.r file. This can be useful e.g. if you want to load a different file using gfd.

Usage

getmd(fn = "def", ...)

Arguments

fn	Character length one. The filename of the metadata file to load. If left at 'def', the default filename for a metadata-file as specified in the settings (what is "metadata.r") is read in. Provide any other valid name of a metadata-file to load it. (Do not forget the '.r' at the end.)
...	Provide the argument 'expName' to override the experiment name specified in the metadata.r file.

Details

The name of the default metadata-file can be specified in the settings. Only the experiment name can be changed via the ... argument by providing the argument 'expName'. Other arguments will be ignored.

Value

An (invisible) list with all the metadata of the experiment.

See Also

metadata_file, getap, gdmm

Examples

## Not run: 
md <- getmd(); str(md); names(md)
md <- getmd("myFile.r")
md <- getmd(expName="OtherName") # to override the experiment name as specified 
# in the metadata.r file.
dataset <- gfd(getmd(expName="OtherName"))

## End(Not run)

bpollner/aquap2 documentation built on March 29, 2024, 7:33 a.m.