defineBeads {PhIPData}

R Documentation

Defining how beads-only samples are encoded.

Description

getBeadsName and setBeadsName are two function to get and set the string that encodes which samples are beads-only samples. Information about beads-only samples are stored in the groups column of sampleInfo.

Usage

getBeadsName()

setBeadsName(name)

Arguments

name	a string indicating how beads-only samples are encoded.

Details

If name is of length greater than one, only the first element of the vector is used. Non-character values of name are first coerced into strings.

Value

a string indicating how beads-only samples are encoded.

Functions

• getBeadsName: function that returns a string corresponding to how beads-only samples are encoded.

• setBeadsName: function to set the string that indicates which samples are beads-only samples in the groups column of sampleInfo.

Examples

## Returns the default string, "beads"
getBeadsName()

## Not run since it changes defaults/user settings
## Not run: 
setBeadsName("beads-only")

## End(Not run)

---