annotateRanges {profileplyr} | R Documentation

## Annotate profileplyr ranges to genes using ChIPseeker

### Description

The ranges from the deepTools matrix will be subset based on whether they overlap with specified annotated regions (using ChIPseeker) throughout the genome

### Usage

    annotateRanges(
      object = "profileplyr",
      annotation_subset = "character",
      TxDb,
      annoDb = "character",
      tssRegion = "numeric",
      changeGroupToAnnotation = "logical",
      heatmap_grouping = "character",
      ...
    )

    ## S4 method for signature 'profileplyr'
    annotateRanges(
      object = "profileplyr",
      annotation_subset = NULL,
      TxDb = NULL,
      annoDb = NULL,
      tssRegion = c(-3000, 3000),
      changeGroupToAnnotation = FALSE,
      heatmap_grouping = "group",
      ...
    )

### Arguments

`object` | A profileplyr object
`annotation_subset` | If specific annotations (from ChIPseeker package) are desired, specify them here in a character vector. Can be one or any combination of "Promoter", "Exon", "Intron", "Downstream", "Distal Intergenic", "3p UTR", or "5p UTR". This argument is optional and all annotation types will be included if argument is left out.
`TxDb` | This must be either a TxDb object, a character string that is a path to a GTF file, or character string indicating genome if one of the following - "hg19", "hg38", "mm9", "mm10".
`annoDb` | The annotation package to be used. If the 'TxDb' argument is set to "hg19", "hg38", "mm9", or "mm10" this will automatically be set and this can be left as NULL.
`tssRegion` | This needs to be a vector of two numbers that will define promoter regions. The first number must be negative, while the second number must be positive. Default values are c(-3000, 3000)
`changeGroupToAnnotation` | If the grouping should be changed to the annotations (typically when the ranges will be exported for visualization based on this annotation), this should be TRUE. The default if FALSE, which will keep the grouping that existed before annotating the object. This is typical if the output will be used for finding overlaps with gene lists in the 'groupBy' function.
`heatmap_grouping` | Only relevant if 'keepAnnotationAsGroup' is set to TRUE. This argument needs to be either "group", or "annotation". This will determine how the ranges are grouped in the resulting object. Default is heatmap_grouping = "Group". If there are no groups in the deepTools matrix that was used in the function, this argument is unnecessary
`...` | pass to `annotatePeak`

### Details

tbd

### Value

A profileplyr object

### Methods (by class)

- `profileplyr`: Annotate profileplyr ranges to genes using ChIPseeker

### Examples

    library(SummarizedExperiment)
    example <- system.file("extdata", "example_deepTools_MAT", package = "profileplyr")
    object <- import_deepToolsMat(example)
    object <- object[1:2, , ]

    # annotate ranges with genes using ChIPseeker
    # (NOTE: can choose subset of annotations with 'annotation_subset' argument)

    annotateRanges(object, TxDb = "mm10")

[Package profileplyr version 1.6.0 Index]