kmeRtone1.0 package

Multi-Purpose and Flexible k-Meric Enrichment Analysis Software

addAlphaCol

Add transparency to color.

bedToCoor

Convert a BED file to chromosome-separated csv files.

buildControl

Build control regions

buildKmerTable

Count k-mers from given sequence(s) and build a data.table of k-mer co...

buildMidPatternKmerTable

Count k-mers with specified middle pattern from given sequence(s) and ...

buildRangedKmerTable

Count kmers from a sequence in given ranges and build a data.table of ...

buildRESTurl

Function constructs a URL for a REST API call by appending query param...

calKmerSkew

Function calculates the skew of k-mers based on their occurrence in po...

calPWM

Calculate position weight matrix of overlapping sequences. Simulation ...

catHeader

Function prints a given message in a formatted header with borders.

Coordinate

Loading, manipulating, and analyzing coordinate data.

count_substring_fixed

Count sequence content in a given sequence.

count_substring_regex

Count sequence content in a given sequence.

countBaseComposition

Function performs an analysis of base composition including sequence f...

countChoppedKmers

Function chops k-mers within specified ranges of a sequence and counts...

countDistribution

Function performs an analysis of the distribution of genomic cases.

countKmers

Count k-mers from string(s) using a simple hash table.

countMidPatternContext2

Locate a middle sequence pattern and count its sequence context.

countMidPatternKmers

Count Relevant K-mers with Specified Middle Pattern from Sequence Stri...

countPointContext2

Ccount sequence context of given point positions.

countRangedKmers

Count k-mers in given ranges of a sequence.

countRevCompKmers

Count reverse complement sequence from its opposite strand. Build for ...

countSlidingWindow

Count sequence content in a sliding window of a sequence.

countSlidingWindow2

Count sequence content in a sliding window of a sequence.

downloadNCBIGenomes

Function downloads genome fasta files from the NCBI FTP database. User...

downloadUCSCgenome

Function downloads chromosome-separated fasta genome sequences from th...

example_kmeRtone_score

Example 2-mer enrichment/depletion scores

EXPLORE

Function generates various exploratory analyses.

extractKmers

Extract k-mers from a given Coordinate object and Genome objects

generateGenicElementCoor

Function processes UCSC genePred tables to generate coordinates for va...

generateIntergenicCoor

Resolve and generate genic element coordinates from UCSC genePred tabl...

getCOSMICauthURL

Get COSMIC authenticated URL.

getCOSMICcancerGeneCensus

Get Cancer Gene Census (CGC) from COSMIC database.

getCOSMIClatestVersion

Function retrieves the latest version information of the COSMIC databa...

getCOSMICmutantExport

Function downloads the latest Cosmic Mutant Export data from the COSMI...

getEnsemblData

A generic function to get Ensembl data persistently from a URL. This i...

getEnsemblRegionFeatures

Get features of a given region.

getEnsemblVariantFeatures_serial

Get features of given variant IDs.

getEnsemblVariantFeatures

Get features of given variant IDs.

getGnomADvariants

Get gnomAD VCF file using tabix.

getICTVvirusMetadataResource

Get Virus Metadata Resource (VMR) from International Committee on Taxo...

getNCBIassemblySummary

Get NCBI assembly summary.

getScores

Function calculates scores for k-mers based on case and control k-mer ...

getUCSCgenePredTable

Retrieve Gene Prediction Table from UCSC for a Given Genome

getVCFmetainfo

Read VCF metainfo file using tabix.

initKmerTable

Initialise k-mer table with all possible k-mers

Kmer_Table

A R6 class wrapper for data.table

kmeRtone

kmeRtone all-in-one user interface

loadCoordinate

Build Coordinate object.

loadGenome

Build Genome object.

loadGenomicContents

Function calculates various genomic content metrics based on the provi...

mapKmers

Map k-mers of a given sequence and coordinate

mergeCoordinate

Merge overlapping or continuous regions.

mixColors

Mix color

NCBI_Genome

Class constructor - build NCBI Genome object

partitionCoordinate

Partition overlapping or continuous regions.

persistentDownload

Download file until successful

readBED

Read a BED file. One-based indexing is enforced.

readFASTA

Read FASTA files.

readVCF

Read VCF file using tabix.

readVCF2

Read VCF file using tabix.

removeRegion

Remove overlapping region in coordinate data.table.

reverseComplement

Get reverse complement sequence of DNA

SCORE

Calculate susceptibility scores for k-mers in case and control regions...

scoreKmers

Function calculates the Z-score for each k-mer based on the observed c...

selectGenomesForCrossSpeciesStudy

Select genomes for cross-species studies.

selectRepresentativeFromASM

Select the best representative species from the NCBI assembly summary.

simulatePopulation

Simulate a population given ranges of chromosome sequence to mutate.

splitFASTA

Split a FASTA file by header.

STUDY_ACROSS_POPULATIONS

Study k-mer composition of selected COSMIC causal cancer genes across ...

STUDY_ACROSS_SPECIES

Study k-mer composition across species.

STUDY_CANCER_GENES

Study k-mer composition of causal cancer genes from COSMIC Cancer Gene...

STUDY_GENIC_ELEMENTS

Study k-mer composition across species.

system3

A system2 wrapper. If anything happen, just give me error!

trimCoordinate

Trim out-of-bound coordinates

UCSC_Genome

Class constructor - build Genome object

writeBED

Write a BED file. Zero-based indexing is enforced.

writeFASTA

Write FASTA files.

writeVCF

Write VCF file and compress using bgzip.

A multi-purpose and flexible k-meric enrichment analysis software. 'kmeRtone' measures the enrichment of k-mers by comparing the population of k-mers in the case loci with a carefully devised internal negative control group, consisting of k-mers from regions close to, yet sufficiently distant from, the case loci to mitigate any potential sequencing bias. This method effectively captures both the local sequencing variations and broader sequence influences, while also correcting for potential biases, thereby ensuring more accurate analysis. The core functionality of 'kmeRtone' is the SCORE() function, which calculates the susceptibility scores for k-mers in case and control regions. Case regions are defined by the genomic coordinates provided in a file by the user and the control regions can be constructed relative to the case regions or provided directly. The k-meric susceptibility scores are calculated by using a one-proportion z-statistic. 'kmeRtone' is highly flexible by allowing users to also specify their target k-mer patterns and quantify the corresponding k-mer enrichment scores in the context of these patterns, allowing for a more comprehensive approach to understanding the functional implications of specific DNA sequences on a genomic scale (e.g., CT motifs upon UV radiation damage). Adib A. Abdullah, Patrick Pflughaupt, Claudia Feng, Aleksandr B. Sahakyan (2024) Bioinformatics (submitted).

  • Maintainer: Aleksandr Sahakyan
  • License: GPL-3
  • Last published: 2024-08-30