FluteMLE: Downstream analysis based on MAGeCK-MLE result

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/FluteMLE.R

Description

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

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
FluteMLE(
  gene_summary,
  treatname,
  ctrlname = "Depmap",
  keytype = "Symbol",
  organism = "hsa",
  incorporateDepmap = FALSE,
  cell_lines = NA,
  lineages = "All",
  norm_method = "cell_cycle",
  posControl = NULL,
  omitEssential = FALSE,
  top = 10,
  toplabels = NA,
  scale_cutoff = 2,
  limit = c(0, 200),
  pvalueCutoff = 0.25,
  enrich_method = "ORT",
  proj = NA,
  width = 10,
  height = 7,
  outdir = ".",
  pathview.top = 4,
  verbose = TRUE
)

Arguments

gene_summary

A data frame or a file path to gene summary file generated by MAGeCK-MLE.

treatname

A character vector, specifying the names of treatment samples.

ctrlname

A character vector, specifying the names of control samples. If there is no controls in your CRISPR screen, you can specify "Depmap" as ctrlname and set 'incorporateDepmap=TRUE'.

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.

norm_method

One of "none", "cell_cycle" (default) or "loess".

posControl

A character vector, specifying a list of positive control gene symbols.

omitEssential

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

top

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

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.

pvalueCutoff

A numeric, specifying pvalue cutoff of enrichment analysis, default 1.

enrich_method

One of "ORT"(Over-Representing Test) and "HGT"(HyperGemetric test).

proj

A character, indicating the prefix of output file name, which can't contain special characters.

width

The width of summary pdf in inches.

height

The height of summary pdf in inches.

outdir

Output directory on disk.

pathview.top

Integer, specifying the number of pathways for pathview visualization.

verbose

Boolean

Details

MAGeCK-MLE can be used to analyze screen data from multi-conditioned experiments. MAGeCK-MLE also normalizes the data across multiple samples, making them comparable to each other. The most important ouput of MAGeCK MLE is 'gene_summary' file, which includes the beta scores of multiple conditions and the associated statistics. The 'beta score' for each gene describes how the gene is selected: a positive beta score indicates a positive selection, and a negative beta score indicates a negative selection.

The downstream analysis includes identifying essential, non-essential, and target-associated genes, and performing biological functional category analysis and pathway enrichment analysis of these genes. The function also visualizes genes in the context of pathways to benefit users exploring screening data.

Value

All of the pipeline results is output into the out.dir/MAGeCKFlute_proj, which includes a pdf file and many folders. The pdf file 'FluteMLE_proj_norm_method.pdf' is the summary of pipeline results. For each section in this pipeline, figures and useful data are outputed to corresponding subfolders.

Author(s)

Wubing Zhang

See Also

FluteRRA

Examples

1
2
3
4
5
6
7
file3 = file.path(system.file("extdata", package = "MAGeCKFlute"),
"testdata/mle.gene_summary.txt")
## Not run: 
  # functional analysis for MAGeCK MLE results
  FluteMLE(file3, treatname = "plx", ctrlname = "dmso", proj = "PLX")

## End(Not run)

MAGeCKFlute documentation built on Nov. 8, 2020, 5:40 p.m.