loadDesign: Load a design from a file or R list
In whitwort/plateKinetics: Analysis of kinetic reads from multiwell plates

Description Usage Arguments Details Value See Also

This function should always be used to load design information, whether from a yaml file or R list structure, because it performs validation checks and injects reasonable defaults for missing parameters.

1
2
3

loadDesign(path = getwd(), file = "design.yaml",
  design = yaml::yaml.load_file(fullPath(path, file, findFiles)),
  default = yaml::yaml.load(newDesign(file = NULL)), findFiles = TRUE)

`path`	A path to a directory where source files and (optionally) a design file can be found. Not used if a design is given.
`file`	File name (or pattern if findFiles = TRUE) for the yaml design file. Not used if a design is given.
`design`	A preliminary design data structure to be validated.
`default`	A design object to use as a source of default values to fill in missing entries in `design`.
`findFiles`	Boolean. If TRUE, the paths to the design file and data files can be complete file names or patterns to use to find a file in the project path; if no exact file name match is found then the first file which fits the pattern is picked.

Usually there is no need to call this function directly; use loadExperiment instead.

Several vignettes are included with this package to fully document the options for input files. Run vignette('source-files') for a description of supported input file formats and loader functions.

A validated design object to be used by loadExperiment.

See newDesign for creating a template design.yaml file.

whitwort/plateKinetics documentation built on May 4, 2019, 5:23 a.m.