FluteRRA: Downstream analysis based on MAGeCK-RRA result

View source: R/FluteRRA.R

FluteRRAR Documentation

Downstream analysis based on MAGeCK-RRA result

Description

Integrative analysis pipeline using the gene summary table in MAGeCK RRA results

Usage

FluteRRA(
  gene_summary,
  sgrna_summary = NULL,
  keytype = "Symbol",
  organism = "hsa",
  incorporateDepmap = FALSE,
  cell_lines = NA,
  lineages = "All",
  omitEssential = TRUE,
  top = 5,
  toplabels = NULL,
  scale_cutoff = 2,
  limit = c(2, 100),
  proj = NA,
  width = 12,
  height = 6,
  outdir = ".",
  verbose = TRUE
)

Arguments

gene_summary

A file path or a data frame of gene summary data.

sgrna_summary

A file path or a data frame of sgRNA summary data.

keytype

"Entrez" or "Symbol".

organism

"hsa" or "mmu".

incorporateDepmap

Boolean, indicating whether incorporate Depmap data into analysis.

cell_lines

A character vector, specifying the cell lines in Depmap to be considered.

lineages

A character vector, specifying the lineages in Depmap to be considered.

omitEssential

Boolean, indicating whether omit common essential genes from the downstream analysis.

top

An integer, specifying the number of top selected genes to be labeled in rank figure and the number of top pathways to be shown.

toplabels

A character vector, specifying interested genes to be labeled in rank figure.

scale_cutoff

Boolean or numeric, specifying how many standard deviation will be used as cutoff.

limit

A two-length vector, specifying the minimal and maximal size of gene sets for enrichent analysis.

proj

A character, indicating the prefix of output file name.

width

The width of summary pdf in inches.

height

The height of summary pdf in inches.

outdir

Output directory on disk.

verbose

Boolean

Details

MAGeCK RRA allows for the comparison between two experimental conditions. It can identify genes and sgRNAs are significantly selected between the two conditions. The most important output of MAGeCK RRA is the file 'gene_summary.txt'. MAGeCK RRA will output both the negative score and positive score for each gene. A smaller score indicates higher gene importance. MAGeCK RRA will also output the statistical value for the scores of each gene. Genes that are significantly positively and negatively selected can be identified based on the p-value or FDR.

The downstream analysis of this function includes identifying positive and negative selection genes, and performing biological functional category analysis and pathway enrichment analysis of these genes.

Value

All of the pipeline results is output into the out.dir/proj_Results, which includes a pdf file and a folder named 'RRA'.

Author(s)

Wubing Zhang

See Also

FluteMLE

Examples

file1 = file.path(system.file("extdata", package = "MAGeCKFlute"),
"testdata/rra.gene_summary.txt")
file2 = file.path(system.file("extdata", package = "MAGeCKFlute"),
                  "testdata/rra.sgrna_summary.txt")
## Not run: 
    # Run the FluteRRA pipeline
    FluteRRA(file1, file2, proj="Pmel", organism="hsa", incorporateDepmap = FALSE,
    scale_cutoff = 1, outdir = "./")

## End(Not run)


WubingZhang/MAGeCKFlute documentation built on Jan. 27, 2024, 2:43 p.m.