SELEX (version 1.4.0)

selex.sample: Create a sample handle

Description

A function used to create a sample handle for conveniently referencing visible samples in other SELEX functions.

Usage

selex.sample(seqName, sampleName, round, index=NULL)

Arguments

seqName

Sequencing run name

sampleName

Sample name

round

Sample round

index

Row number of desired sample when using selex.sampleSummary. When used, overrides other variables.

Value

selex.sample returns a sample handle object.

Details

A sample is considered `visible' to the current SELEX session when its metadata has been loaded or defined and the sample's sequencing run info name, sample name, and round is displayed when selex.sampleSummary is called. Alternatively, a row number from selex.sampleSummary can be used to reference a sample. A sample handle is an object that contains a reference to one visible sample. This object can be passed to SELEX functions instead of explicitly passing all sample information (such as variable region length, barcodes, round, FASTQ file location, etc).

See Also

selex.defineSample, selex.getAttributes, selex.loadAnnotation, selex.sampleSummary

Examples

r0 = selex.sample(seqName="R0.libraries", sampleName="R0.barcodeGC", round=0)
r2 = selex.sample(index=3)