get_chip_index {TFEA.ChIP} | R Documentation

## Creates df containing accessions of ChIP-Seq datasets and TF.

### Description

Function to create a data frame containing the ChIP-Seq dataset accession IDs and the transcription factor tested in each ChIP. This index is used in functions like “contingency_matrix” and “GSEA_run” as a filter to select specific ChIPs or transcription factors to run an analysis.

### Usage

    get_chip_index(encodeFilter = FALSE, TFfilter = NULL)

### Arguments

`encodeFilter` | (Optional) If TRUE, only ENCODE ChIP-Seqs are included in the index.
`TFfilter` | (Optional) Transcription factors of interest.

### Value

Data frame containig the accession ID and TF for every ChIP-Seq experiment included in the metadata files.

### Examples

    get_chip_index(encodeFilter = TRUE)
    get_chip_index(TFfilter=c('SMAD2','SMAD4'))

[Package TFEA.ChIP version 1.12.0 Index]