common_coefs_prot: Perform Pearson coefficient mapping of all pairs of genes in...

In ytakemon/GINIR: Genetic inteRaction and EssenTiality neTwork mApper

Perform Pearson coefficient mapping of all pairs of genes in a protein co-expression analysis

Description

Performs Pearson correlation coefficient analyses between all gene pairs found in a protein co-expression analysis. Input parameters should match those used to run annotate_df().

Usage

common_coefs_prot(
  input_genes = NULL,
  input_disease = NULL,
  input_cell_lines = NULL,
  core_num = NULL,
  output_dir = NULL,
  data_dir = NULL,
  filename = NULL,
  test = FALSE
)

Arguments

input_genes	string, A vector containing one or more "Hugo Symbol", Default: NULL
input_disease	string, A vector one or more disease contexts, Will perform pan-cancer analyses (all cell lines) by default, Default: NULL
input_cell_lines	string, A vector DepMap_IDs for which co-essentiality mapping will be performed on. Will perform pan-cancer analyses (all cell lines) by default, Default: NULL
core_num	integer, Number of cores to run analysis, Default: NULL
output_dir	string, Full path to where output file should be saved, Default: NULL
data_dir	string Path to GRETTA_data
filename	string name of file without the '.csv' extension.
test	logical, TRUE/FALSE whether you want to run only a small subset (first 10 genes) to ensure function will run properly prior to running all genes. Default: FALSE.

Details

Description of output data frame

• GeneNameID_A - Hugo symbol of query gene.

• GeneNameID_B - Hugo symbol of all genes quantified.

• estimate - Correlation coefficient output from ?cor.test.

• statistic - Pearson's correlation statistic. Output from ?cor.test.

• p.value - P-value from Pearson's correlation statistic. Output from ?cor.test.

• parameter - Degrees of freedom. Output from ?cor.test.

Value

A data frame containing Pearson correlation coefficients. A copy is also saved to the directory defined in output_dir.

Examples

gretta_data_dir <- './GRETTA_example/'
gretta_output_dir <- './GRETTA_example_output/'

if(!dir.exists(gretta_data_dir)){
  download_example_data(".")
}

## Not run: 
coess_df <- common_coefs_prot(
input_gene = c("ARID1A", "SMARCB1"),
input_disease = 'Pancreatic Cancer',
core_num = 2,
data_dir = gretta_data_dir, 
output_dir = gretta_output_dir,
test = TRUE)

## End(Not run)

ytakemon/GINIR documentation built on Oct. 11, 2024, 6:06 a.m.