run_comparison: Run a comparison between two cohorts (e.g. cell lines and...

View source: R/run_comparison.R

run_comparisonR Documentation

Run a comparison between two cohorts (e.g. cell lines and tumors)

Description

Run a comparison between two cohorts (e.g. cell lines and tumors)

Usage

run_comparison(
  available_data_types = c("mut", "cna", "exp"),
  mut_data_type_weight = 1/3,
  cna_data_type_weight = 1/3,
  exp_data_type_weight = 1/3,
  cna_default_weight = 0.01,
  mut_default_weight = 0.01,
  exp_default_weight = 0.01,
  tumor_mut_file,
  tumor_cna_file,
  tumor_exp_file,
  cell_line_mut_file,
  cell_line_cna_file,
  cell_line_exp_file,
  known_cancer_gene_weights_mut_file,
  known_cancer_gene_weights_cna_file,
  known_cancer_gene_weights_exp_file,
  cancer_specific_gene_weights_mut_file,
  cancer_specific_gene_weights_cna_file,
  cancer_specific_gene_weights_exp_file,
  run_mds = TRUE
)

Arguments

available_data_types

a vector of data types to be analyzed

mut_data_type_weight

a numeric weight for the data type (NOTE: data type weights must sum to 1)

cna_data_type_weight

a numeric weight for the data type (NOTE: data type weights must sum to 1)

exp_data_type_weight

a numeric weight for the data type (NOTE: data type weights must sum to 1)

cna_default_weight

default (background) weight for copy number alterations (CNA) (DEFAULT: 0.01). Default weights are assigned to genes not known to be important in the specific cancer type or cancer in general

mut_default_weight

default (background) weight for mutation alterations (MUT) (DEFAULT: 0.01); CNA_default_weight

exp_default_weight

default (background) weight for mRNA gene expression values (EXP) (DEFAULT: 0.01)

tumor_mut_file

a file with binary mutation data for tumors

tumor_cna_file

a file with GISTIC data for tumors; this can be 5-values (-2, -1, 0, 1, 2) or continuous

tumor_exp_file

a file with gene expression data for tumors

cell_line_mut_file

a file with binary mutation data for cell lines

cell_line_cna_file

a file with GISTIC data for cell lines; this can be 5-values (-2, -1, 0, 1, 2) or continuous

cell_line_exp_file

a file with gene expression data for cell lines

known_cancer_gene_weights_mut_file

a file with weights for genes known to be recurrently altered/mutated in cancer (e.g. recurrently mutated genes in TCGA pan-cancer analyses). A two-column tab-delimited file - the first column has the gene names and the second column specifies the weights.

known_cancer_gene_weights_cna_file

for copy number; see known_cancer_gene_weights_mut_file

known_cancer_gene_weights_exp_file

for expression; see known_cancer_gene_weights_mut_file

cancer_specific_gene_weights_mut_file

a file with weights for cancer-specific set of recurrently mutated genes. A tab-delimited file - the first column has the gene names, and the second column specifies the weights.

cancer_specific_gene_weights_cna_file

for copy number; see cancer_specific_gene_weights_mut_file

cancer_specific_gene_weights_exp_file

for expression; see cancer_specific_gene_weights_mut_file

run_mds

a boolean, whether to run multidimensional scaling (MDS) on dataset (Default: TRUE)

Value

a list with multiple items. NOTE: The values of the dist and isomdsfit will depend on parameter whether the values for a data type are discrete or continuous

  • dist_mat: a matrix of pairwise distances

  • isomdsfit: a two-column (2-dimension) fitting of the distances reduced to two dimensions via MDS - multidimensional scaling, using the isoMDS function

  • cor_unweighted: a matrix of unweighted pairwise correlations

  • composite_mat: the composite matrix (see Details)

  • cell_line_ids: a vector of cell line IDs/names with all data types

  • tumor_ids: a vector of tumor IDs with all data types

Author(s)

Rileen Sinha (rileen@gmail.com), Augustin Luna (aluna@jimmy.harvard.edu)

Examples

tumor_mut_file <- system.file("extdata", "READ_data_for_running_TC", "tumor_mut.txt", 
  package="tumorcomparer")
tumor_cna_file <- system.file("extdata", "READ_data_for_running_TC", "tumor_cna.txt", 
  package="tumorcomparer")
tumor_exp_file <- system.file("extdata", "READ_data_for_running_TC", "tumor_exp.txt", 
  package="tumorcomparer")

cell_line_mut_file <- system.file("extdata", "READ_data_for_running_TC", "cell_line_mut.txt", 
  package="tumorcomparer")
cell_line_cna_file <- system.file("extdata", "READ_data_for_running_TC", "cell_line_cna.txt", 
  package="tumorcomparer")
cell_line_exp_file <- system.file("extdata", "READ_data_for_running_TC", "cell_line_exp.txt", 
  package="tumorcomparer")

known_cancer_gene_weights_mut_file <- system.file("extdata", "READ_data_for_running_TC", 
  "default_weights_for_known_cancer_genes_mut.txt", package="tumorcomparer")
known_cancer_gene_weights_cna_file <- system.file("extdata", "READ_data_for_running_TC", 
  "default_weights_for_known_cancer_genes_cna.txt", package="tumorcomparer")
known_cancer_gene_weights_exp_file <- system.file("extdata", "READ_data_for_running_TC", 
  "default_weights_for_known_cancer_genes_exp.txt", package="tumorcomparer")

cancer_specific_gene_weights_mut_file <- system.file("extdata", "READ_data_for_running_TC", 
  "Genes_and_weights_mut.txt", package="tumorcomparer")
cancer_specific_gene_weights_cna_file <- system.file("extdata", "READ_data_for_running_TC", 
  "Genes_and_weights_cna.txt", package="tumorcomparer")
cancer_specific_gene_weights_exp_file <- system.file("extdata", "READ_data_for_running_TC", 
  "Genes_and_weights_exp.txt", package="tumorcomparer")

comparison_result <- run_comparison(
available_data_types=c("mut", "cna", "exp"), 
mut_data_type_weight = 1/3,
cna_data_type_weight = 1/3,
exp_data_type_weight = 1/3,
cna_default_weight=0.01, 
mut_default_weight=0.01,
exp_default_weight=0.01,
tumor_mut_file=tumor_mut_file, 
tumor_cna_file=tumor_cna_file, 
tumor_exp_file=tumor_exp_file, 
cell_line_mut_file=cell_line_mut_file, 
cell_line_cna_file=cell_line_cna_file, 
cell_line_exp_file=cell_line_exp_file, 
known_cancer_gene_weights_mut_file=known_cancer_gene_weights_mut_file, 
known_cancer_gene_weights_cna_file=known_cancer_gene_weights_cna_file, 
known_cancer_gene_weights_exp_file=known_cancer_gene_weights_exp_file, 
cancer_specific_gene_weights_mut_file=cancer_specific_gene_weights_mut_file, 
cancer_specific_gene_weights_cna_file=cancer_specific_gene_weights_cna_file, 
cancer_specific_gene_weights_exp_file=cancer_specific_gene_weights_exp_file)


cannin/tumorcomparer documentation built on Feb. 7, 2023, 3:13 p.m.