Skip to content

EpigenomeInformatics/methylTFR

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

146 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

methylTFR : Quantification of DNA Methylation Patterns in TFBS

R-CMD-check-bioc R-CMD-check GitHub issues GitHub pulls

methylTFR is an R-package to analyze DNA methylation signatures in transcription factor binding sites in each individual cells or samples.

Installation instructions

Get the latest release methylTFR from Bioconductor using the following code:

if (!requireNamespace("BiocManager", quietly = TRUE)) {
  install.packages("BiocManager")
}

BiocManager::install("methylTFR")

And the development version from GitHub with:

if (!requireNamespace("remotes", quietly = TRUE)) {
  install.packages("remotes")
}
remotes::install_github("EpigenomeInformatics/methylTFR")

Quick Start

This is a basic example which shows you how to run methylTFR :

library(GenomicRanges)
library(dplyr)
library(methylTFRAnnotationHg38) # annotation package for hg38
library(methylTFR)

gcfreqs <- getGCfreq(motifSet = "jaspar2020")
gc_dist <- getGenomeGC("hg38")
tf_bindsites <- getTFbindsites(motifSet = "jaspar2020")

sample_dir <- file.path("samples_dir")
sample_ann <- "samples.tsv" # should contain column name bedFile

# deviation score matrix
deviations <- run_methyltfr(sample_ann, # sample annotation file
  sample_dir, # where the EPP files are
  threads = 8, # number of threads
  chunkSize = 10, # number of chunks to process
  sampleColName = "bedFile", # column name for EPP file paths in sample_ann
  tf_bindsites = tf_bindsites, # TF binding sites
  gcfreqs = gcfreqs, # GC frequency
  gc_dist = gc_dist, # GC distribution
  filetype = "EPP" # file type
)

Citation

Below is the citation output from using citation('methylTFR') in R. Please run this yourself to check for any updates on how to cite methylTFR.

print(citation("methylTFR"), bibtex = TRUE)
#> 
#> To cite package 'methylTFR' in publications use:
#> 
#>   Irem B. Gündüz, Sarath Kumar Murugan and Fabian Muller (2026).
#>   methylTFR: Quantification of DNA Methylation Signatures in TFBS. R
#>   package version 0.99.0.
#>   https://github.com/EpigenomeInformatics/methylTFR
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Manual{,
#>     title = {methylTFR: Quantification of DNA Methylation Signatures in TFBS},
#>     author = {Irem B. Gündüz and Sarath Kumar Murugan and Fabian Muller},
#>     year = {2026},
#>     note = {R package version 0.99.0},
#>     url = {https://github.com/EpigenomeInformatics/methylTFR},
#>   }

Contributors

Languages