Learn R Programming

RnBeads (version 1.4.0)

read.idat.files: read.idat.files

Description

Reads a directory of .idat files and initializes an object of type MethyLumiSet.

Usage

read.idat.files(base.dir, barcodes = NULL, sample.sheet = NULL, sep.samples = rnb.getOption("import.table.separator"), useff = FALSE, verbose = TRUE)

Arguments

base.dir
Directory that contains the .idat files to be read; or a character vector of such directories.
barcodes
Optional non-empty character vector listing the barcodes of the samples that should be loaded. If supplied, this vector must not contain NA among its elements.
sample.sheet
Optional file name containing a table of sample annotation data, or the table itself in the form of a data.frame or matrix. Only (and all) samples defined in this table will be loaded. The table is expected to contain a column named "barcode" that lists the samples' Sentrix barcodes. If such a column is not present, this function searches for columns "Sentrix_ID" and "Sentrix_Position" (or similar) that build a barcode.
sep.samples
character string used as field separator in the sample sheet file. Default value is taken by the call to rnb.getOption("import.table.separator")
useff
If TRUE ff package is used to store large matrices on the hard disk
verbose
Flag specifying whether the messages to the logger should be sent. Note that the logger must be initialized prior to calling this function. Logging is useful for keeping a record of the downloaded and processed samples. Also, informative messages are stored in case of an error.

Value

Loaded dataset of HumanMethylation450K samples, encapsulated in an object of type MethyLumiSet.

Details

If neither barcodes, nor sample.sheet are specified, the function attempts to locate a file in base.dir containing sample annotation information. It fails ifsuch a file cannot be (unambiguously) identified. If both barcodes and sample.sheet are supplied, only sample.sheet is used in loading methylation data. The value of barcodes is tested for validity but it is not used as a filter.

See Also

methylumIDAT in package methylumi