tfactivity
Bioinformatics pipeline that makes use of expression and open chromatin data to identify differentially active transcription factors across conditions.
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 14 DOI reference(s) in README -
✓Academic publication links
Links to: scholar.google -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.9%) to scientific vocabulary
Keywords
Repository
Bioinformatics pipeline that makes use of expression and open chromatin data to identify differentially active transcription factors across conditions.
Basic Info
- Host: GitHub
- Owner: nf-core
- License: mit
- Language: Nextflow
- Default Branch: dev
- Homepage: https://nf-co.re/tfactivity
- Size: 7.83 MB
Statistics
- Stars: 12
- Watchers: 179
- Forks: 5
- Open Issues: 4
- Releases: 0
Topics
Metadata Files
README.md
Introduction
nf-core/tfactivity is a bioinformatics pipeline that can identify the most differentially active transcription factors (TFs) between multiple conditions. It takes a count matrix and open chromatin data (ATAC-seq, DNase-seq, HM-ChIP-seq) as input. It produces a ranking of transcription factors.

- Identify accessible regions (can perform footprinting between close ChIP-seq peaks or take ATAC-seq peaks)
- Calculate affinity scores for combinations of transcription factors and target genes (TGs) using STARE
- Identify differentially expressed genes between conditions
- Utilize linear regression to identify the transcription factors that are most likely to be responsible for the differential gene expression
- Calculate the TF-TG score based on:
- Differential expression of the target genes
- Affinity of the transcription factors to the target genes
- The regression coefficient of the transcription factors
- Perform a Mann-Whitney U test and create a ranking of the transcription factors
A more biological visualization of the workflow can be found here:
[!NOTE] The following image was created for the TF-Prioritizer publication. Parts of the workflow have been adapted for the nf-core pipeline, but the general idea is still valid.

Usage
[!NOTE] If you are new to Nextflow and nf-core, please refer to this page on how to set-up Nextflow. Make sure to test your setup with
-profile testbefore running the workflow on actual data.
The pipeline supports processing of previously called peaks from ATAC-seq, DNase-seq, or histone modification ChIP-seq data. The peaks can then either be used as-is or be subjected to footprinting analysis. Additionally, BAM files can be provided in a separate samplesheet, which will be used to predict enhancer regions.
csv title="samplesheet.csv"
sample,condition,assay,peak_file
condition1_H3K27ac_1,condition1,H3K27ac,condition1_H3K27ac_1.broadPeak
condition1_H3K27ac_2,condition1,H3K27ac,condition1_H3K27ac_2.broadPeak
condition1_H3K4me3,condition1,H3K4me3,condition1_H3K4me3.broadPeak
condition2_H3K27ac,condition2,H3K27ac,condition2_H3K27ac.broadPeak
condition3_H3K27ac,condition3,H3K27ac,condition3_H3K27ac.broadPeak
condition3_H3K4me3,condition3,H3K4me3,condition3_H3K4me3.broadPeak
Each row represents a peak file. The sample column should contain a unique identifier for each peak file. The peak_file column should contain the path to the peak file. Peak files need to be in a format that is compatible with the bed format. Only the first three columns of the bed format are used.
csv title="samplesheet_bam.csv"
sample,condition,assay,signal,control
condition1_H3K27ac_1,condition1,H3K27ac,condition1_H3K27ac_1.bam,condition1_control.bam
condition1_H3K27ac_2,condition1,H3K27ac,condition1_H3K27ac_2.bam,condition1_control.bam
condition1_H3K4me3,condition1,H3K4me3,condition1_H3K4me3.bam,condition1_control.bam
condition2_H3K27ac,condition2,H3K27ac,condition2_H3K27ac.bam,condition2_control.bam
condition3_H3K27ac,condition3,H3K27ac,condition3_H3K27ac.bam,condition3_control.bam
condition3_H3K4me3,condition3,H3K4me3,condition3_H3K4me3.bam,condition3_control.bam
The first three columns are the same as in the peak file samplesheet. The signal column should contain the path to the signal BAM file. The control column should contain the path to the control BAM file.
Second, you need a raw count matrix (e.g. from nf-core/rnaseq) with gene IDs as rows and samples as columns. You also need a design matrix that specifies the conditions of the samples in the count matrix. The design matrix should look as follows:
csv title="design_matrix.csv"
sample,condition
sample1,condition1
sample2,condition1
sample3,condition2
sample4,condition3
The sample column should match the columns in the expression matrix. The condition column is needs to match the condition column in the samplesheet. Additionally,batches can be added to the design matrix and will be considered in the differential expression analysis.
:::tip There is an alternative way of providing expression values. Instead of providing a single count matrix for all samples, you can provide a gene list and one count file per sample. Details can be found in the usage documentation. :::
Now, you can run the pipeline using:
bash
nextflow run nf-core/tfactivity \
-profile <docker/singularity/.../institute> \
--input samplesheet.csv \
--genome GRCh38 \
--counts <EXPRESSION_MATRIX> \
--counts_design design_matrix.csv \
--outdir <OUTDIR>
[!WARNING] Please provide pipeline parameters via the CLI or Nextflow
-params-fileoption. Custom config files including those provided by the-cNextflow option can be used to provide any configuration except for parameters; see docs.
For more details and further functionality, please refer to the usage documentation and the parameter documentation.
Pipeline output
To see the results of an example test run with a full size dataset refer to the results tab on the nf-core website pipeline page. For more details about the output files and reports, please refer to the output documentation.
Credits
nf-core/tfactivity was originally written by Nico Trummer.
We thank the following people for their extensive assistance in the development of this pipeline:
- Markus Hoffmann (project and scientific management)
- Leon Hafner (implementations)
Contributions and Support
If you would like to contribute to this pipeline, please see the contributing guidelines.
For further information or help, don't hesitate to get in touch on the Slack #tfactivity channel (you can join with this invite).
Citations
TF-Prioritizer: a Java pipeline to prioritize condition-specific transcription factors
Markus Hoffmann, Nico Trummer, Leon Schwartz, Jakub Jankowski, Hye Kyung Lee, Lina-Liv Willruth, Olga Lazareva, Kevin Yuan, Nina Baumgarten, Florian Schmidt, Jan Baumbach, Marcel H Schulz, David B Blumenthal, Lothar Hennighausen & Markus List
GigaScience, Volume 12, 2023, giad026, https://doi.org/10.1093/gigascience/giad026
An extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.
You can cite the nf-core publication as follows:
The nf-core framework for community-curated bioinformatics pipelines.
Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.
Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x.
Owner
- Name: nf-core
- Login: nf-core
- Kind: organization
- Email: core@nf-co.re
- Website: http://nf-co.re
- Twitter: nf_core
- Repositories: 84
- Profile: https://github.com/nf-core
A community effort to collect a curated set of analysis pipelines built using Nextflow.
Citation (CITATIONS.md)
# nf-core/tfactivity: Citations ## [nf-core](https://pubmed.ncbi.nlm.nih.gov/32055031/) > Ewels PA, Peltzer A, Fillinger S, Patel H, Alneberg J, Wilm A, Garcia MU, Di Tommaso P, Nahnsen S. The nf-core framework for community-curated bioinformatics pipelines. Nat Biotechnol. 2020 Mar;38(3):276-278. doi: 10.1038/s41587-020-0439-x. PubMed PMID: 32055031. ## [Nextflow](https://pubmed.ncbi.nlm.nih.gov/28398311/) > Di Tommaso P, Chatzou M, Floden EW, Barja PP, Palumbo E, Notredame C. Nextflow enables reproducible computational workflows. Nat Biotechnol. 2017 Apr 11;35(4):316-319. doi: 10.1038/nbt.3820. PubMed PMID: 28398311. ## Pipeline tools - [DeSeq2](https://doi.org/10.1186/s13059-014-0550-8) > Love, M.I., Huber, W. & Anders, S. Moderated estimation of fold change and dispersion for RNA-seq data with DESeq2. Genome Biol 15, 550 (2014). - [STARE](https://doi.org/10.1093/bioinformatics/btad062) > Dennis Hecker, Fatemeh Behjati Ardakani, Alexander Karollus, Julien Gagneur, Marcel H Schulz, The adapted Activity-By-Contact model for enhancer–gene assignment and its application to single-cell data, Bioinformatics, Volume 39, Issue 2, February 2023 - [Bedtools](https://doi.org/10.1093%2Fbioinformatics%2Fbtq033) > Quinlan AR, Hall IM. BEDTools: a flexible suite of utilities for comparing genomic features. Bioinformatics. 2010 Mar 15;26(6):841-2. doi: 10.1093/bioinformatics/btq033. Epub 2010 Jan 28. PMID: 20110278; PMCID: PMC2832824. - [GTFtools](https://doi.org/10.1093/bioinformatics/btac561) > Hong-Dong Li, Cui-Xiang Lin, Jiantao Zheng, GTFtools: a software package for analyzing various features of gene models, Bioinformatics, Volume 38, Issue 20, 15 October 2022, Pages 4806–4808, ## Software packaging/containerisation tools - [Anaconda](https://anaconda.com) > Anaconda Software Distribution. Computer software. Vers. 2-2.4.0. Anaconda, Nov. 2016. Web. - [Bioconda](https://pubmed.ncbi.nlm.nih.gov/29967506/) > Grüning B, Dale R, Sjödin A, Chapman BA, Rowe J, Tomkins-Tinch CH, Valieris R, Köster J; Bioconda Team. Bioconda: sustainable and comprehensive software distribution for the life sciences. Nat Methods. 2018 Jul;15(7):475-476. doi: 10.1038/s41592-018-0046-7. PubMed PMID: 29967506. - [BioContainers](https://pubmed.ncbi.nlm.nih.gov/28379341/) > da Veiga Leprevost F, Grüning B, Aflitos SA, Röst HL, Uszkoreit J, Barsnes H, Vaudel M, Moreno P, Gatto L, Weber J, Bai M, Jimenez RC, Sachsenberg T, Pfeuffer J, Alvarez RV, Griss J, Nesvizhskii AI, Perez-Riverol Y. BioContainers: an open-source and community-driven framework for software standardization. Bioinformatics. 2017 Aug 15;33(16):2580-2582. doi: 10.1093/bioinformatics/btx192. PubMed PMID: 28379341; PubMed Central PMCID: PMC5870671. - [Docker](https://dl.acm.org/doi/10.5555/2600239.2600241) > Merkel, D. (2014). Docker: lightweight linux containers for consistent development and deployment. Linux Journal, 2014(239), 2. doi: 10.5555/2600239.2600241. - [Singularity](https://pubmed.ncbi.nlm.nih.gov/28494014/) > Kurtzer GM, Sochat V, Bauer MW. Singularity: Scientific containers for mobility of compute. PLoS One. 2017 May 11;12(5):e0177459. doi: 10.1371/journal.pone.0177459. eCollection 2017. PubMed PMID: 28494014; PubMed Central PMCID: PMC5426675.
GitHub Events
Total
- Issues event: 8
- Watch event: 2
- Delete event: 25
- Issue comment event: 54
- Push event: 156
- Pull request review comment event: 23
- Pull request review event: 30
- Pull request event: 50
- Fork event: 2
- Create event: 25
Last Year
- Issues event: 8
- Watch event: 2
- Delete event: 25
- Issue comment event: 54
- Push event: 156
- Pull request review comment event: 23
- Pull request review event: 30
- Pull request event: 50
- Fork event: 2
- Create event: 25
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 5
- Total pull requests: 26
- Average time to close issues: 5 months
- Average time to close pull requests: 15 days
- Total issue authors: 4
- Total pull request authors: 5
- Average comments per issue: 4.0
- Average comments per pull request: 1.0
- Merged pull requests: 15
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 4
- Pull requests: 26
- Average time to close issues: 3 months
- Average time to close pull requests: 15 days
- Issue authors: 3
- Pull request authors: 5
- Average comments per issue: 2.25
- Average comments per pull request: 1.0
- Merged pull requests: 15
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- LeonHafner (3)
- nictru (2)
- KeyTals (1)
- nf-core-bot (1)
- yussufhajjaj (1)
- asundaresan1 (1)
- pnatarajan9 (1)
Pull Request Authors
- LeonHafner (16)
- nictru (14)
- nf-core-bot (10)
- ewels (1)
- maxulysse (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/upload-artifact v4 composite
- seqeralabs/action-tower-launch v2 composite
- actions/upload-artifact v4 composite
- seqeralabs/action-tower-launch v2 composite
- mshick/add-pr-comment b8f338c590a895d50bcbfa6c5859251edc8952fc composite
- actions/checkout b4ffde65f46336ab88eb53be808477a3936bae11 composite
- jlumbroso/free-disk-space 54081f138730dfa15788a46383842cd2f914a1be composite
- nf-core/setup-nextflow v1 composite
- actions/stale 28ca1036281a5e5922ead5184a1bbf96e5fc984e composite
- actions/setup-python 0a5c61591373683505ea898e09a3ea4f39ef2b9c composite
- eWaterCycle/setup-singularity 931d4e31109e875b13309ae1d07c70ca8fbc8537 composite
- nf-core/setup-nextflow v1 composite
- actions/checkout b4ffde65f46336ab88eb53be808477a3936bae11 composite
- actions/setup-python 0a5c61591373683505ea898e09a3ea4f39ef2b9c composite
- peter-evans/create-or-update-comment 71345be0265236311c031f5c7866368bd1eff043 composite
- actions/checkout b4ffde65f46336ab88eb53be808477a3936bae11 composite
- actions/setup-python 0a5c61591373683505ea898e09a3ea4f39ef2b9c composite
- actions/upload-artifact 5d5d22a31266ced268874388b861e4b58bb5c2f3 composite
- nf-core/setup-nextflow v1 composite
- dawidd6/action-download-artifact f6b0bace624032e30a85a8fd9c1a7f8f611f5737 composite
- marocchino/sticky-pull-request-comment 331f8f5b4215f0445d3c07b4967662a32a2d3e31 composite
- actions/setup-python 0a5c61591373683505ea898e09a3ea4f39ef2b9c composite
- rzr/fediverse-action master composite
- zentered/bluesky-post-action 80dbe0a7697de18c15ad22f4619919ceb5ccf597 composite
- 3d-force-graph 1.73.3
- @babel/runtime 7.24.1
- @tweenjs/tween.js 23.1.1
- accessor-fn 1.5.0
- d3-array 3.2.4
- d3-binarytree 1.0.2
- d3-color 3.1.0
- d3-dispatch 3.0.1
- d3-force-3d 3.0.5
- d3-format 3.1.0
- d3-interpolate 3.0.1
- d3-octree 1.0.2
- d3-quadtree 3.0.1
- d3-scale 4.0.2
- d3-scale-chromatic 3.1.0
- d3-time 3.1.0
- d3-time-format 4.1.0
- d3-timer 3.0.1
- data-joint 1.3.1
- index-array-by 1.4.1
- internmap 2.0.3
- kapsule 1.14.5
- lodash-es 4.17.21
- ngraph.events 1.2.2
- ngraph.forcelayout 3.3.1
- ngraph.graph 20.0.1
- ngraph.merge 1.0.0
- ngraph.random 1.1.0
- polished 4.3.1
- regenerator-runtime 0.14.1
- three 0.163.0
- three-forcegraph 1.41.13
- three-render-objects 1.29.3
- three-spritetext 1.8.2
- tinycolor2 1.6.0
- 3d-force-graph ^1.73.3
- three ^0.163.0
- three-spritetext ^1.8.2
- actions/checkout 11bd71901bbe5b1630ceea73d27597364c9af683 composite
- mshick/add-pr-comment b8f338c590a895d50bcbfa6c5859251edc8952fc composite
- nichmor/minimal-read-yaml v0.0.2 composite
- pandas 2.2.3.*
- pyyaml 6.0.2.*
- sneep 1.1.*
- atlas-gene-annotation-manipulation 1.1.1.*
- bedtools 2.31.1.*
- bedtools 2.31.1.*
- bedtools 2.31.1.*
- bedtools 2.31.1.*
- bedtools 2.31.1.*
- bedtools 2.31.1.*
- bedtools 2.31.1.*
- pigz 2.3.4.*
- bioconductor-deseq2 1.34.0.*
- coreutils 8.25.*
- sed 4.7.*
- htslib 1.20.*
- samtools 1.20.*
- htslib 1.20.*
- samtools 1.20.*