getap: Get Analysis Procedure

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

Get Analysis Procedure

Description

Read in the analysis procedure from the default or a custom analysis procedure file located in the metadata-folder. By providing any of the arguments of the analysis procedure file (see anproc_file) to the function you can override the values in the file with the provided values.

Usage

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

Arguments

fn	Character length one. The filename of the analysis procedure file to load. If left at 'def', the default filename for an analysis procedure file as specified in the settings (factory default is "anproc.r") is read in. Provide any other valid name of an analysis procedure file to load it. (Do not forget the '.r' at the end.)
...	Any of the arguments of the analysis procedure - please see anproc_file. Any argument/value provided via ... will override the value in the analysis procedure .r file.

Details

The name of the default analysis procedure file can be specified in the settings. The provided value and defaults will be checked in gdmm and the resulting aquap_cube contains the final analysis procedure in its slot @anproc.

Value

An (invisible) list with the analysis procedure.

See Also

anproc_file, getmd, gdmm

Examples

## Not run: 
ap <- getap(); str(ap); names(ap)
ap <- getap("myFile.r")
ap <- getap(pca.colorBy="C_Group") # change the value of 'pca.colorBy'
from the .r file to 'C_Group'
ap <- getap(do.sim=FALSE) # switch off the calculation of SIMCA models
ap <- getap(spl.var="C_Group") # change the split variable to "C_Group"

## End(Not run)

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