Skip to content
TFregulomeR reveals transcription factors’ context-specific features and functions
R
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R update to v2.0.0 Mar 5, 2020
inst update to v2.0.0 Mar 5, 2020
man update to v2.0.0 Mar 5, 2020
tests add unittests Jan 31, 2019
vignettes upgrade to 1.2.0 Sep 17, 2019
.gitignore added travis test Feb 1, 2019
DESCRIPTION update to v2.0.0 Mar 5, 2020
LICENSE change license Jan 10, 2020
NAMESPACE update to v2.0.0 Mar 5, 2020
NEWS update to v2.0.0 Mar 5, 2020
README.md edit readme.md Mar 6, 2020
TFregulomeR.Rproj TFregulomR start up Jan 2, 2019

README.md

TFregulomeR

v2.0.0 new

New features:

  1. Link to data compendium hosted in Singapore and Canada;
  2. Link to TF motifs and DNA methylation in human and mouse;
  3. Perform TF interactome analysis coupled with DNA methylation and other chromatin signals such as chromatin accessibility.

Introduction

TFregulomeR comprises of a comprehensive compendium of transcription factor binding sites (TFBSs) derived from the MethMotif and GTRD, as well as the ready-to-use functionality in R language facilitating data access, integration and analysis. The binding motifs predicted in-silico from MethMotif and GTRD describe cell specific transcription factor (TF) binding propensities, while the DNA methylation profiles from MethMotif portray a second epigenetic dimension in TF binding events. The whole toolbox allows a better understanding of the TF binding propensities in a cell-specific manner.


Release notes

This repository is TFregulomeR stable release

Current TFregulomeR stable version: 2.0.0 (Updated on 5 March 2020).

For development release, please visit TFregulomeR-dev


Documentation

You can check detailed package instructions in Vignettes


Current Functionalities v2.0.0

Click here for functionality update notes

Currently, TFregulomeR links to data compendium hosted in Singapore (default) and Canada. User is able to switch the servers by changing the input parameter 'server' when using those functions highlighted as 'multi-servers' below. For Singapore server, please use server='sg', and for Canada one, please use server='ca'. For example, when browsing TFregulomeR data compendium hosted in Canada, using dataBrowser(server='ca'). For details, please refer to the Vignettes.

Note: new function is highlighted in bold font.

  1. Browse the TFregulomeR data compendium (dataBrowser(), multi-servers)
  2. Load TF peaks (loadPeaks(), multi-servers)
  3. Search motif matrix and DNA methylation score matrix (searchMotif(), multi-servers)
  4. Plot motif or MethMotif logo (plotLogo)
  5. Export motif matrix and DNA methylation score matrix (exportMMPFM)
  6. Get context-independent peaks along with DNA methylation profiles (commonPeaks(), multi-servers, & commonPeakResult())
  7. Get context-dependent peaks along with DNA methylation profiles (exclusivePeaks(), multi-servers, & exclusivePeakResult())
  8. Form a intersected matrix between two lists of peak sets along with DNA methylation profiles, read enrichments and users' input external signals, for interactome and co-binding partner studies (intersectPeakMatrix(), multi-servers, & intersectPeakMatrixResult()). - NEW Feature
  9. Automatically generate a PDF report for TF co-factors along with motif sequences, DNA methylation (within motif and in 200bp regions) and read enrichments (cofactorReport()).
  10. Automatically produce a dynamic three-dimensional interface showing TF interactome coupled with DNA methylation and/or users’ input external signal values (interactome3D()). - NEW Function
  11. Plot the TFBS distribution in a given list of peak sets (motifDistrib(), multi-servers, & plotDistrib()).
  12. Annotate peak genomic locations (genomeAnnotate(), multi-servers).
  13. Annotate ontologies of target genes by a peak set (greatAnnotate()).
  14. Convert a motif matrix to a PFMatrix calss object for TFBSTools package (toTFBSTools(), multi-servers).

Current TFBSs in TFregulomeR compendium

Click here for TFregulomeR compendium update notes

TFregulomeR data compendium version: 2.0.0

Item Count
PWM 2333
Unique TF 676
PWM with DNA methylation records 679
Species human (hg38) and mouse (mm10)
Organ brain, stem_cell, blood_and_lymph, connective_tissue, liver, colorectum, muscle, bone, stomach, prostate, pancreas, skin, eye, breast, intestine, kidney, lung, esophagus, heart, testis, uterus, spleen, limb, body, cervix, placenta, undefined, adrenal_gland, neck_and_mouth, head, ovary, pleura, thymus, fallopian, vagina
Sample type primary_cells, cell_line, tissue
Cell or tissue 721
Disease state normal, tumor, Simpson_Golabi_Behmel_syndrome, progeria, metaplasia, unknown, immortalized, premetastatic
Source GTRD, MethMotif

Citation

Quy Xiao Xuan Lin, Denis Thieffry, Sudhakar Jha, Touati Benoukraf. (2019) TFregulomeR reveals transcription factors’ context-specific features and functions. Nucleic Acids Res., 10.1093/nar/gkz1088. [Manuscript]


Case studies

The scripts of case studies used in our manuscript are available as below.

  1. Case study of CEBPB
  2. Case study of MAFF
  3. Case study of ATF3

Installation

Prerequisite pakcages

  1. Required packages: the packages below are the basic prerequisite packages for TFregulomeR functionalities

  2. Optional packages: the packages below are optional since they are required only in some functions or some options in a function

Install

In R console,

# if you have not installed "devtools" package
install.packages("devtools")
devtools::install_github("benoukraflab/TFregulomeR")

The step above will automatically install the required packages. However, you still need to install optional packages if you opt to use the functions such as greatAnnotate(), genomeAnnotate() and toTFBSTools().


License

GNU General Public License v3.0

You can’t perform that action at this time.