showChipInfo: Display a ChipInfo object

Description Usage Arguments Value See Also

View source: R/humarray.R

Description

Returns a preview of a ChipInfo object to the console. This is similar to a GRanges preview, but the seqlevels are hidden, the UCSC build and chip name are displayed, start and end are merged to the virtual label 'position' (as it's assume we are dealing with SNPs, not ranges), the strand by default is hidden, and the integer codes for pass/fail in QCcodes() are displayed as 'pass' or 'fail', even though this is not how they are represented internally. This is called by the default 'show' method for ChipInfo objects.

Usage

1
2
showChipInfo(x, margin = "", with.classinfo = FALSE,
  print.seqlengths = FALSE, ...)

Arguments

x

a ChipInfo object

margin

margin for display, usually ""

with.classinfo

logical, whether to display class information

print.seqlengths

logical, whether to display sequence lengths below the main output listing (e.g, chromsomes). Usually tidier when this is FALSE.

...

hidden arguments including: 'head.tail'; number of SNPs to display at start/end (only the head and tail are shown as these objects are generally very large with >100K SNPs); 'up.to'; only SNPs at the start and end are generally displayed, however this parameter specifies that when there are <= 'up.to' SNPs, then all SNPs will be displayed; 'show.strand'; logical, by default the strand is hidden, particularly given that the strand can vary between different datasets of the same chip. Setting to TRUE will display the strand.

Value

print compact preview of the object to the standard output (terminal)

See Also

ChipInfo


humarray documentation built on Nov. 20, 2017, 1:05 a.m.