TissueOpennessSpecificity {enrichTF} | R Documentation

## Tissue's open specificity of the given region

### Description

User provide region through a BED file. This function will provide tissue's open specificity analysis for this region. Open level median, distribution and clustering result (heatmap) based on tissue and region will be provided.

### Usage

    enrichTissueOpennessSpecificity(
      prevStep,
      bedInput = NULL,
      openBedInput = NULL,
      sampleTxtInput = NULL,
      bedOutput = NULL,
      distPdfOutput = NULL,
      heatmapPdfOutput = NULL,
      sampleTxtOutput = NULL,
      ...
    )

    ## S4 method for signature 'Step'
    enrichTissueOpennessSpecificity(
      prevStep,
      bedInput = NULL,
      openBedInput = NULL,
      sampleTxtInput = NULL,
      bedOutput = NULL,
      distPdfOutput = NULL,
      heatmapPdfOutput = NULL,
      sampleTxtOutput = NULL,
      ...
    )

    tissueOpennessSpecificity(
      bedInput,
      openBedInput = NULL,
      sampleTxtInput = NULL,
      bedOutput = NULL,
      distPdfOutput = NULL,
      heatmapPdfOutput = NULL,
      sampleTxtOutput = NULL,
      ...
    )

### Arguments

`prevStep` | `Step-class` object scalar. This parameter is available when the upstream step function (printMap() to see the previous functions) have been sucessfully called. Accepted value can be the object return by any step function or be feed by `%>%` from last step function.
`bedInput` | `Character` scalar. The directory of region BED file for analysis.
`openBedInput` | `Character` scalar. The open level BED file for analysis. The first three columns are chromosome, start and end, The remaining columns are the open level for each tissue. The order of tissue should be consistent with the order in the file provided by sampleTxtInput.
`sampleTxtInput` | `Character` scalar. The tissue sample information of in the file provided by openBedInput. There are 4 columns seperated by tab. The first column is the order number. The second column is the tissue detail information. The third column is the tissue name. The forth column is the code from source project like ENCODE
`bedOutput` | `Character` scalar. The BED output file directory of merged BED files. Default: NULL (generated base on bedInput)
`distPdfOutput` | `Character` scalar. The open level distribution figure for each tissue will be provided in PDF file. The order is strong to weak.
`heatmapPdfOutput` | `Character` scalar. The open level hiachical clustering heatmap base on region and tissue will be provided in this PDF file. The corresponding heatmap data will store at the same directory with suffix .Rdata
`sampleTxtOutput` | `Character` scalar. In this file, there are five columns seperated with tab. Fist four columns are the same with sampleTxtInput: The first column is the order number. The second column is the tissue detail information. The third column is the tissue name. The forth column is the code from source project like ENCODE The last column is the open level median level for each tissue. The table is in decreasing order of last column
`...` | Additional arguments, currently unused.

### Details

We collect 201 DNase-seq or ATAC-seq sample from ENCODE and calculate their open level value. They can be download and install automatically. So users do not need to configure themselves.

### Value

An invisible `EnrichStep-class` object (`Step-class` based) scalar for downstream analysis.

### Author(s)

Zheng Wei

### See Also

`unzipAndMergeBed`

### Examples

    foregroundBedPath <- system.file(package = "enrichTF", "extdata","testregion.bed")
    tissueOpennessSpecificity(bedInput = foregroundBedPath)

[Package enrichTF version 1.10.0 Index]