newDesign: Write a new design object out to a yaml file.

In whitwort/plateKinetics: Analysis of kinetic reads from multiwell plates

Description

This function serializes a design object out to a yaml text file or character vector. It is useful for writing a design object out to a file for future use or for creating a template design file.

Usage

newDesign(design = list(loader = "read.table", platform = "96", wells =
  "A1 -> H12", channels = list(channel1 = "data1.txt", channel2 = "data2.txt"),
  factors = list(factor1 = list(`A1->H6` = "A", `A7->H12` = "B"), factor2 =
  list(`A1->D12` = "C", `E1->H12` = "D"))), file = "design.yaml")

Arguments

design	A optional design object. Defaults to a sample experimental design.
file	An optional file path to use for creating a yaml text file. containing design. Defaults to 'design.yaml' in the current working directory.

Value

A character vector containing yaml text.

Examples

## Not run: 
# Create a template design file in the current directory
newDesign()

# Create a new design file in a diferent directory
newDesign(file = "~/myproj/my-design.yaml")


## End(Not run)

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