Function reference • ISAnalytics

Import functions

Importing integration matrices and metadata from files

import_association_file(): Import the association file from disk

import_Vispa2_stats(): Import Vispa2 stats given the aligned association file.

import_single_Vispa2Matrix(): Import a single integration matrix from file

import_parallel_Vispa2Matrices(): Import integration matrices from paths in the association file.

Data cleaning and pre-processing

annotation_issues(): Check for genomic annotation problems in IS matrices.

compute_near_integrations(): Scans input matrix to find and merge near integration sites.

remove_collisions(): Identifies and removes collisions.

realign_after_collisions(): Re-aligns matrices of other quantification types based on the processed sequence count matrix.

outlier_filter(): Filter out outliers in metadata, identified by the chosen outlier test.

outliers_by_pool_fragments(): Identify and flag outliers based on pool fragments.

aggregate_metadata(): Performs aggregation on metadata contained in the association file.

aggregate_values_by_key(): Aggregates matrices values based on specified key.

Analysis functions

compute_abundance(): Computes the abundance for every integration event in the input data frame.

top_integrations(): Sorts and keeps the top n integration sites based on the values in a given column.

top_targeted_genes(): Top n targeted genes based on number of IS.

sample_statistics(): Computes user specified functions on numerical columns and updates the metadata data frame accordingly.

CIS_grubbs(): Grubbs test for Common Insertion Sites (CIS).

CIS_grubbs_overtime(): Compute CIS and Grubbs test over different time points and groups.

gene_frequency_fisher(): Compute Fisher's exact test on gene frequencies.

cumulative_is(): Expands integration matrix with the cumulative IS union over time.

is_sharing(): Sharing of integration sites between given groups.

purity_filter(): Filter integration sites based on purity.

iss_source(): Find the source of IS by evaluating sharing.

HSC_population_size_estimate(): Hematopoietic stem cells population size estimate.

Plotting functions

CIS_volcano_plot(): Trace volcano plot for computed CIS data.

top_cis_overtime_heatmap(): Heatmaps for the top N common insertion sites over time.

HSC_population_plot(): Plot of the estimated HSC population size for each patient.

integration_alluvial_plot(): Alluvial plots for IS distribution in time.

top_abund_tableGrob(): Summary top abundant tableGrobs for plots.

sharing_heatmap(): Plot IS sharing heatmaps.

sharing_venn(): Produce tables to plot sharing venn or euler diagrams.

circos_genomic_density(): Trace a circos plot of genomic densities.

fisher_scatterplot(): Plot results of gene frequency Fisher's exact test.

Utility functions

as_sparse_matrix(): Converts tidy integration matrices in the original sparse matrix form.

generate_blank_association_file(): Create a blank association file.

generate_Vispa2_launch_AF(): Creates a reduced association file for a VISPA2 run, given project and pool

inspect_tags(): Retrieve description of a tag by name.

available_tags(): All available tags for dynamic vars look-up tables.

set_mandatory_IS_vars() set_annotation_IS_vars() set_af_columns_def() set_iss_stats_specs(): Define custom dynamic vars.

reset_mandatory_IS_vars() reset_annotation_IS_vars() reset_af_columns_def() reset_iss_stats_specs() reset_matrix_file_suffixes() reset_dyn_vars_config(): Resets dynamic vars to the default values.

mandatory_IS_vars() annotation_IS_vars() association_file_columns() iss_stats_specs() matrix_file_suffixes(): Current dynamic vars specifications getters.

set_matrix_file_suffixes(): Sets the look-up table for matrix file suffixes.

export_ISA_settings(): Export a dynamic vars settings profile.

import_ISA_settings(): Import a dynamic vars settings profile.

pcr_id_column(): Easily retrieve the name of the pcr id column.

transform_columns(): Apply transformations to an arbitrary number of columns.

comparison_matrix(): Obtain a single integration matrix from individual quantification matrices.

separate_quant_matrices(): Separate a multiple-quantification matrix into single quantification matrices.

generate_default_folder_structure(): Generate a default folder structure, following VISPA2 standards

enable_progress_bars(): Enable global progress bars for ISAnalytics functions.

NGSdataExplorer(): Launch the shiny application NGSdataExplorer.

Exported variables and helpers

date_formats(): Possible choices for the dates_format parameter in import_association_file, import_parallel_vispa2Matrices_interactive and import_parallel_vispa2Matrices_auto.

matching_options(): Possible choices for the matching_opt parameter.

quantification_types(): Possible choices for the quantification_type parameter.

reduced_AF_columns(): Names of the columns of the association file to consider for Vispa2 launch.

default_stats(): A set of pre-defined functions for sample_statistics.

clinical_relevant_suspicious_genes(): Clinical relevant suspicious genes (for mouse and human).

known_clinical_oncogenes(): Known clinical oncogenes (for mouse and human).

available_outlier_tests(): A character vector containing all the names of the currently supported outliers tests that can be called in the function outlier_filter.

blood_lineages_default(): Default blood lineages info

default_iss_file_prefixes(): Default regex prefixes for Vispa2 stats files.

default_meta_agg(): Default metadata aggregation function table

default_report_path(): Default folder for saving ISAnalytics reports. Supplied as default argument for several functions.

refGene_table_cols(): Required columns for refGene file.

default_af_transform(): Default transformations to apply to association file columns.

default_rec_agg_lambdas(): Defaults for column aggregations in compute_near_integrations().

Deprecated

import_parallel_Vispa2Matrices_interactive(): Import integration matrices from association file.

import_parallel_Vispa2Matrices_auto(): Import integration matrices from association file.

cumulative_count_union(): Integrations cumulative count in time by sample

unzip_file_system(): A utility function to unzip and use example file systems included in the package

threshold_filter(): Filter data frames with custom predicates

Data

association_file: Example of association file.

integration_matrices: Example of imported multi-quantification integration matrices.

proto_oncogenes tumor_suppressors: Data frames for proto-oncogenes (human and mouse) amd tumor-suppressor genes from UniProt.

refGenes_hg19 refGenes_mm9: Gene annotation files for hg19, mm9 and mm10.