Results-methods: Method Results

Description Usage Arguments Value Examples

Description

Method Results

Report the (Differential) Modification Peaks/Sites and their associated LFC Statistics

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
Results(
  sep,
  cut_off_pvalue = NULL,
  cut_off_padj = 0.05,
  cut_off_log2FC = 0,
  min_num_of_positive = 30,
  expected_direction = c("both", "hyper", "hypo"),
  inhibit_filter = FALSE,
  table_style = c("bed", "granges")
)

## S4 method for signature 'SummarizedExomePeak'
Results(
  sep,
  cut_off_pvalue = NULL,
  cut_off_padj = 0.1,
  cut_off_log2FC = 0,
  min_num_of_positive = 100,
  expected_direction = c("both", "hyper", "hypo"),
  inhibit_filter = FALSE,
  table_style = c("bed", "granges")
)

Arguments

sep

a SummarizedExomePeak object.

cut_off_pvalue

a numeric value for the p value cutoff in the exported result; Default = NULL.

cut_off_padj

a numeric value for the adjusted p value cutoff in the exported result; Default = 0.05.

cut_off_log2FC

a numeric value for the log2 fold change (LFC) cutoff of the exported result, only the sites with abs(LFC) larger than this value are kept; Default = 0.

min_num_of_positive

a numeric value for the minimum number of reported sites. If the number of remaining sites is less than this number after the filter, additional sites will be reported by the increasing order of the p value to meet this number.

expected_direction

a character for the expected direction of the differential modification, could be one in c("hyper", "hypo", "both").

hyper

only report the peaks/sites with interactive LFC > 0.

hypo

only report the peaks/sites with interactive LFC < 0.

both

report the peaks/sites in both directions.

This argument is useful when the treated group involves the perturbation of a known writer or eraser protein; Default "both".

inhibit_filter

a logical for whether to remove all the filters, this option is useful when quantification on single based site annotation; Default = FALSE.

table_style

a character for the style of the table being returned, could be one in c("bed","granges").

bed

The genomic locations in the table are represented by BEDgraph style.

granges

The genomic locations in the table are represented by GRanges style.

Value

a data.frame containing the genomic locations of modification peaks/sites, gene ids, and their statistics.

Examples

1
2
3
4
5
6
7
### Load the example SummarizedExomPeak object
f1 = system.file("extdata", "sep_ex_mod.rds", package="exomePeak2")

sep <- readRDS(f1)

### Check the modification peaks/sites statistics.
head(Results(sep))

exomePeak2 documentation built on Nov. 8, 2020, 5:27 p.m.