ICAMS2.3.12 package

In-Depth Characterization and Analysis of Mutational Signatures ('ICAMS')

GetCustomKmerCounts

Generate custom k-mer abundance from a given reference genome

GetGenomeKmerCounts

Generate k-mer abundance from a given genome

GetMutationLoadsFromMutectVCFs

Get mutation loads information from Mutect VCF files.

GetMutationLoadsFromStrelkaIDVCFs

Get mutation loads information from Strelka ID VCF files.

GetMutationLoadsFromStrelkaSBSVCFs

Get mutation loads information from Strelka SBS VCF files.

GetSequenceKmerCounts

Generate k-mer abundance from given nucleotide sequences

GetStrandedKmerCounts

Generate stranded k-mer abundance from a given genome and gene annotat...

GetVAF

Extract the VAFs (variant allele frequencies) and read depth informati...

ICAMS

ICAMS: In-depth Characterization and Analysis of Mutational Signatures

InferAbundance

Infer abundance given a matrix-like object and additional informat...

InferCatalogClassPrefix

These two functions is applicable only for internal ICAMS-formatted ca...

InferCatalogInfo

This function converts an data.table imported from external catalog te...

InferRownames

Infer the correct rownames for a matrix based on its number of rows

IsGRCh37

Test if object is BSgenome.Hsapiens.1000genome.hs37d5.

IsGRCh38

Test if object is BSgenome.Hsapiens.UCSC.hg38.

IsGRCm38

Test if object is BSgenome.Mmusculus.UCSC.mm10.

MakeDataFrameFromVCF

Read in the data lines of a Variant Call Format (VCF) file

MakeVCFDBSdf

MakeVCFDBSdf Take DBS ranges and the original VCF and generate a VCF w...

MutectVCFFilesToCatalog

Create SBS, DBS and Indel catalogs from Mutect VCF files

MutectVCFFilesToCatalogAndPlotToPdf

Create SBS, DBS and Indel catalogs from Mutect VCF files and plot them...

MutectVCFFilesToZipFile

Create a zip file which contains catalogs and plot PDFs from Mutect VC...

NormalizeGenomeArg

Take strings representing a genome and return the BSgenome object.

Plot96PartOfCompositeToPDF

Plot the SBS96 part of a SignatureAnalyzer COMPOSITE signature or cata...

PlotCatalog

Plot one spectrum or signature

PlotCatalogToPdf

Plot catalog to a PDF file

PlotPPM

Plot position probability matrix (PPM) for one sample from a Variant...

PlotPPMToPdf

Plot position probability matrices (PPM) to a PDF file

AddAndCheckDBSClassInVCF

Add and check DBS class in an annotated VCF with the corresponding DBS...

AddAndCheckSBSClassInVCF

Add and check SBS class in an annotated VCF with the corresponding SBS...

AddDBSClass

Add DBS mutation class to an annotated DBS VCF

AddRunInformation

Create a run information text file from generating zip archive from VC...

AddSBSClass

Add SBS mutation class to an annotated SBS VCF

AddSeqContext

Add sequence context to a data frame with mutation records

AddTranscript

Add transcript information to a data frame with mutation records

AnnotateDBSVCF

Add sequence context and transcript information to an in-memory DBS VC...

AnnotateIDVCF

Add sequence context to an in-memory ID (insertion/deletion) VCF, and ...

AnnotateSBSVCF

Add sequence context and transcript information to an in-memory SBS VC...

as.catalog

Create a catalog from a matrix, data.frame, or vector

CalBaseCountsFrom3MerAbundance

Calculate base counts from three mer abundance

CalculateNumberOfSpace

Calculate the number of space needed to add strand bias statistics to ...

Canonicalize1Del

Given a deletion and its sequence context, categorize it

Canonicalize1ID

Given a single insertion or deletion in context categorize it.

Canonicalize1INS

Given an insertion and its sequence context, categorize it.

CanonicalizeID

Determine the mutation types of insertions and deletions.

CatalogRowOrder

Standard order of row names in a catalog

CheckAndFixChrNames

Check and, if possible, correct the chromosome names in a VCF `data.fr...

CheckAndFixChrNamesForTransRanges

Check and, if possible, correct the chromosome names in a trans.ranges...

CheckAndReorderRownames

Check whether the rownames of object are correct, if yes then put th...

CheckAndReturnDBSCatalogs

Check and return DBS catalogs

CheckAndReturnDBSMatrix

Check and return the DBS mutation matrix

CheckAndReturnIDCatalog

Check and return ID catalog

CheckAndReturnIDMatrix

Check and return the ID mutation matrix

CheckAndReturnSBSCatalogs

Check and return SBS catalogs

CheckAndReturnSBSMatrix

Check and return the SBS mutation matrix

CheckDBSClassInVCF

Check DBS mutation class in VCF with the corresponding DBS mutation ma...

CheckSBSClassInVCF

Check SBS mutation class in VCF with the corresponding SBS mutation ma...

CheckSeqContextInVCF

Check that the sequence context information is consistent with the val...

CollapseCatalog

"Collapse" a catalog

ConvertICAMSCatalogToSigProSBS96

Covert an ICAMS SBS96 Catalog to SigProfiler format

CreateDinucAbundance

Create dinucleotide abundance

CreateExomeStrandedRanges

Create exome transcriptionally stranded regions

CreateOneColDBSMatrix

Create the matrix a DBS catalog for one sample from an in-memory VCF...

CreateOneColIDMatrix

Create one column of the matrix for an indel catalog from one in-mem...

CreateOneColSBSMatrix

Create the matrix an SBS catalog for one sample from an in-memory VC...

CreateOnePPMFromSBSVCF

Create position probability matrix (PPM) for one sample from a Varia...

CreatePentanucAbundance

Create pentanucleotide abundance

CreatePPMFromSBSVCFs

Create position probability matrices (PPM) from a list of SBS vcfs

CreateStrandedDinucAbundance

Create stranded dinucleotide abundance

CreateStrandedTrinucAbundance

Create stranded trinucleotide abundance

CreateTetranucAbundance

Create tetranucleotide abundance

CreateTransRanges

Create a transcript range file from the raw GFF3 File

CreateTrinucAbundance

Create trinucleotide abundance

FindDelMH

Return the length of microhomology at a deletion

FindMaxRepeatDel

Return the number of repeat units in which a deletion is embedded

FindMaxRepeatIns

Return the number of repeat units in which an insertion is embedded.

GeneExpressionData

Example gene expression data from two cell lines

GenerateEmptyKmerCounts

Generate an empty matrix of k-mer abundance

GenerateKmer

Generate all possible k-mers of length k.

GetConsensusVAF

Analogous to GetMutectVAF, calculating VAF and read depth from PCAWG...

PlotTransBiasGeneExp

Plot transcription strand bias with respect to gene expression values

PlotTransBiasGeneExpToPdf

Plot transcription strand bias with respect to gene expression values ...

ReadAndSplitMutectVCFs

Read and split Mutect VCF files

ReadAndSplitStrelkaSBSVCFs

Read and split Strelka SBS VCF files

ReadAndSplitVCFs

Read and split VCF files

ReadBedRanges

Read chromosome and position information from a bed format file.

ReadCatalog

Read catalog

ReadCatalogErrReturn

Get error message and either stop or create a null error output for re...

ReadCatalogInternal

Internal read catalog function to be wrapped in a tryCatch

ReadDukeNUSCat192

Read a 192-channel spectra (or signature) catalog in Duke-NUS format

ReadMutectVCF

Read in the data lines of a Variant Call Format (VCF) file created by ...

ReadMutectVCFs

Read Mutect VCF files.

ReadStapleGT96SBS

Read a 96-channel spectra (or signature) catalog where rownames are e....

ReadStrelkaIDVCF

Read in the data lines of an ID VCF created by Strelka version 1

ReadStrelkaIDVCFs

Read Strelka ID (small insertion and deletion) VCF files

ReadStrelkaSBSVCF

Read in the data lines of an SBS VCF created by Strelka version 1

ReadStrelkaSBSVCFs

Read Strelka SBS (single base substitutions) VCF files.

ReadTranscriptRanges

Read transcript ranges and strand information from a gff3 format file....

ReadVCF

Read in the data lines of a Variant Call Format (VCF) file

ReadVCFs

Read VCF files

RemoveRangesOnBothStrand

Remove ranges that fall on both strands

RenameColumnsWithNameStrand

Is there any column in df with name "strand"? If there is, change it...

RenameColumnsWithNameVAF

Is there any column in df1 with name "VAF"? If there is, change its na...

Restaple1536

Convert 1536-channel mutation-type identifiers like this `"ACCGTA" -> ...

Restaple96

Convert 96-channel mutation-type identifiers like this `"ACTA" -> "A[C...

revc

Reverse complement every string in string.vec

RevcDBS144

Reverse complement strings that represent stranded DBSs

RevcSBS96

Reverse complement strings that represent stranded SBSs

SplitListOfMutectVCFs

Split each Mutect VCF into SBS, DBS, and ID VCFs (plus VCF-like data f...

SplitListOfStrelkaSBSVCFs

Split a list of in-memory Strelka SBS VCF into SBS, DBS, and variants ...

SplitListOfVCFs

Split each VCF into SBS, DBS, and ID VCFs (plus VCF-like data frame wi...

SplitOneMutectVCF

Split a mutect2 VCF into SBS, DBS, and ID VCFs, plus a list of other m...

SplitOneVCF

Split a VCF into SBS, DBS, and ID VCFs, plus a list of other mutations

SplitSBSVCF

Split an in-memory SBS VCF into pure SBSs, pure DBSs, and variants inv...

SplitStrelkaSBSVCF

Split an in-memory Strelka VCF into SBS, DBS, and variants involving >...

StandardChromName

Standardize the chromosome name annotations for a data frame.

StandardChromNameNew

Standardize the chromosome name annotations for a data frame.

StopIfCatalogTypeIllegal

Stop if catalog.type is illegal.

StopIfNrowIllegal

Stop if the number of rows in object is illegal

StopIfRegionIllegal

Stop if region is illegal.

StopIfTranscribedRegionIllegal

Stop if region is illegal for an in-transcript catalogs

StrelkaIDVCFFilesToCatalog

Create ID (small insertion and deletion) catalog from Strelka ID VCF f...

StrelkaIDVCFFilesToCatalogAndPlotToPdf

Create ID (small insertion and deletion) catalog from Strelka ID VCF f...

StrelkaIDVCFFilesToZipFile

Create a zip file which contains ID (small insertion and deletion) cat...

StrelkaSBSVCFFilesToCatalog

Create SBS and DBS catalogs from Strelka SBS VCF files

StrelkaSBSVCFFilesToCatalogAndPlotToPdf

Create SBS and DBS catalogs from Strelka SBS VCF files and plot them t...

StrelkaSBSVCFFilesToZipFile

Create a zip file which contains catalogs and plot PDFs from Strelka S...

TCFromCouSigCou

Source catalog type is counts or counts.signature

TCFromDenSigDen

density -> <anything> density.signature -> density.signature, counts.s...

TestMakeCatalogFromMutectVCFs

This function makes catalogs from the sample Mutect VCF file and compa...

TestMakeCatalogFromStrelkaIDVCFs

This function is to make catalogs from the sample Strelka ID VCF files...

TestMakeCatalogFromStrelkaSBSVCFs

This function is to make catalogs from the sample Strelka SBS VCF file...

TestPlotCatCOMPOSITE

Plot the a SignatureAnalyzer COMPOSITE signature or catalog into separ...

TranscriptRanges

Transcript ranges data

TransformCatalog

Transform between counts and density spectrum catalogs and counts and ...

TransRownames.ID.PCAWG.SigPro

For indels, convert ICAMS/PCAWG7 rownames into SigProfiler rownames

TransRownames.ID.SigPro.PCAWG

For indels, convert SigProfiler rownames into ICAMS/PCAWG7 rownames

Unstaple1536

Convert SBS1536-channel mutations-type identifiers like this `"AC[C>A]...

Unstaple78

Convert DBS78-channel mutations-type identifiers like this `"AC>GA" ->...

Unstaple96

Convert SBS96-channel mutations-type identifiers like this `"A[C>A]T" ...

VCFsToCatalogs

Create SBS, DBS and Indel catalogs from VCFs

VCFsToCatalogsAndPlotToPdf

Create SBS, DBS and Indel catalogs from VCFs and plot them to PDF

VCFsToDBSCatalogs

Create DBS catalogs from VCFs

VCFsToIDCatalogs

Create ID (small insertion and deletion) catalog from ID VCFs

VCFsToSBSCatalogs

Create SBS catalogs from SBS VCFs

VCFsToZipFile

Create a zip file which contains catalogs and plot PDFs from VCFs

VCFsToZipFileXtra

Analogous to VCFsToZipFile, also generates density CSV and PDF files...

WriteCat

Write a catalog to a file.

WriteCatalog

Write a catalog

WriteCatalogIndelSigPro

Write Indel Catalogs in SigProExtractor format

Analysis and visualization of experimentally elucidated mutational signatures -- the kind of analysis and visualization in Boot et al., "In-depth characterization of the cisplatin mutational signature in human cell lines and in esophageal and liver tumors", Genome Research 2018, <doi:10.1101/gr.230219.117> and "Characterization of colibactin-associated mutational signature in an Asian oral squamous cell carcinoma and in other mucosal tumor types", Genome Research 2020 <doi:10.1101/gr.255620.119>. 'ICAMS' stands for In-depth Characterization and Analysis of Mutational Signatures. 'ICAMS' has functions to read in variant call files (VCFs) and to collate the corresponding catalogs of mutational spectra and to analyze and plot catalogs of mutational spectra and signatures. Handles both "counts-based" and "density-based" (i.e. representation as mutations per megabase) mutational spectra or signatures.

  • Maintainer: Steve Rozen
  • License: GPL-3 | file LICENSE
  • Last published: 2024-02-09