readSeqsumm {seqCNA} | R Documentation

## Function that reads seqsumm summarized files.

### Description

The function reads the `seqsumm_out.txt` file(s) from the indicated directories and builds a `SeqCNAInfo-class` object, with read count (RC) and genomic information.

### Usage

    readSeqsumm(build="", tumour.data=NULL, normal.data=NULL, folder=NULL, normal.folder=NULL, resample.win=NULL, sex=TRUE, nproc=2)

### Arguments

`build` | String indicating the genome and build used to generate and annotate the output `SeqCNAInfo-class` object. Currently, the annotation package supports `hg18` and `hg19`. This means that common CNV and mappability filters are only available for these builds, and that GC content is estimated from the tumoural sample - or the normal sample if available.
`tumour.data` | A dataframe with the seqsumm information for the tumoural sample.
`normal.data` | If applicable, a dataframe with the seqsumm information for the normal sample. Otherwise, disregard this parameter.
`folder` | Path to the folder where the tumoural sample `seqsumm_out.txt` file is located. Only used if no data is passed through the `{tumour.data}` parameter.
`normal.folder` | If applicable, path to the folder where the paired normal sample `seqsumm_out.txt` file is located. Otherwise, disregard this parameter. Only used if no data is passed through the `{normal.data}` parameter.
`resample.win` | An integer that allows to specify a new bigger summarization window. If used, it must be an exact multiple of the window in the data read.
`sex` | A boolean indicating whether to read sex chromosomes into the output `SeqCNAInfo-class` object.
`nproc` | A value indicating how many processing cores to use for the process of resampling, if applicable. Greater values speed up resampling using more CPU cores and RAM memory, but you should not use values greater than the number of cores in your machine. If unsure, the safest value is 1, but most computers nowadays are multi-core, so you could probably go up to 2, 4 or 8.

### Details

See `seqsumm_HCC1143` for an example table read by the function.

### Value

A `SeqCNAInfo-class` object, with information on read count (RC), genome build, and summarization window size and position. If applicable, it also contains paired normal RC. If paired-end mapping (PEM) was used in the alignment, RCs are broken down by read type.

### Author(s)

David Mosen-Ansorena

### Examples

    data(seqsumm_HCC1143)
    rco = readSeqsumm(tumour.data=seqsumm_HCC1143)

[Package seqCNA version 1.38.0 Index]