Probe_file_parser: Probe file parser

Description Usage Arguments Details Value Author(s) See Also

Description

These functions are examples of probe file parsers, as requested by process to produce a cghRA.probes object from a CGH array data file.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
  Agilent.probes(
    file,
    columns = c(
      rFin = "rProcessedSignal",
      gFin = "gProcessedSignal",
      flag_rIsSaturated = "rIsSaturated",
      flag_gIsSaturated = "gIsSaturated",
      flag_rIsFeatNonUnifOL = "rIsFeatNonUnifOL",
      flag_gIsFeatNonUnifOL = "gIsFeatNonUnifOL",
      flag_rIsBGNonUnifOL = "rIsBGNonUnifOL",
      flag_gIsBGNonUnifOL = "gIsBGNonUnifOL",
      flag_rIsFeatPopnOL = "rIsFeatPopnOL",
      flag_gIsFeatPopnOL = "gIsFeatPopnOL",
      flag_rIsBGPopnOL = "rIsBGPopnOL",
      flag_gIsBGPopnOL = "gIsBGPopnOL"
    ),
    ...
  )
  custom.probes(file, columns = NULL, ...)

Arguments

file

Single character value, path to the file to extract the design from (Agilent Feature Extraction file).

columns

Character vector defining the columns to extract, the names are the names to use in the cghRA.probes object while the values are the names used in the Feature Extraction file.

...

Further arguments are ignored by Agilent.probes and custom.probes, but can be used by other probe file parsers.

Details

As the package was developped with Agilent arrays, only the corresponding parser and a generic one are currently provided. Parsing arrays from other brands can be achieved providing a custom probe file parser suiting the manufacturer file format. Common brand file parsers may be added in the future, if you developped one (or need one to be developped) and wish it to be added to the package, please contact the package maintainer.

As this function will be exported for parallel computing, dependencies need to be explicit : packages need library calls (even the core ones) or usage of :: operators and sub-functions should be declared inside the parser body.

"Custom" files must be CSV files, using tabulations as column separators, periods as decimal separators and a first row naming columns. No comment line is allowed, and cell content protection (quoting) can be performed using double-quotes. The mandatory columns are "id" (an integer ID that will be used to match probes between design and data files) and "logRatio" (numeric). Additionally one can provide boolean columns starting with "flag_", to be used as probe filters by process.mask during the array processing. Further columns will be stored as provided.

Value

An object of class cghRA.probes.

Author(s)

Sylvain Mareschal

See Also

cghRA.probes-class


cghRA documentation built on May 2, 2019, 3:34 a.m.