peaksInput {geneXtendeR} | R Documentation

## Preprocesses a peaks input file.

### Description

Takes your tab-delimited 3-column (chromosome number, peak start, and peak end) input file (see ?samplepeaksinput) consisting of peaks called from a peak caller (e.g., MACS2 or SICER) and sorts the file by chromosome and start position, thereby creating a preprocessed file for downstream geneXtendeR analysis. This file (called "peaks.txt") is a preprocessed file of the original input and is deposited in the user's working directory and used for the remainder of the analysis. In this "peaks.txt" file, peaks are sorted by chromosome number and start position, where the X chromosome is designated by the integer 100, the Y chromosome by the integer 200, and the mitochondrial chromosome by the integer 300.

### Usage

    peaksInput(filename)

### Arguments

`filename` | Name of file containing peaks that have been generated from a peak caller (e.g., MACS2, SICER). See ?samplepeaksinput for an example of such an input file.

### Value

Returns a formatted file (called "peaks.txt") that has been preprocessed in preparation for usage with barChart(), linePlot(), distinct(), and other downstream commands and deposited in the user's working directory.

### Examples

    ?samplepeaksinput  #Documentation of some exemplary sample input
    data(samplepeaksinput)
    head(samplepeaksinput)
    tail(samplepeaksinput)
    fpath <- system.file("extdata", "somepeaksfile.txt", package="geneXtendeR")
    peaksInput(fpath)

[Package geneXtendeR version 1.13.0 Index]