Skip to content
Suite of motif tools, including a motif prediction pipeline for ChIP-seq experiments. See full GimmeMotifs documentation for detailed installation instructions and usage examples.
Python C HTML Perl PostScript CSS Other
Branch: master
Clone or download
Latest commit 1dc0572 Dec 5, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates Nov 27, 2018
binder test Dec 5, 2018
data API example Dec 5, 2018
docs fix image Dec 5, 2018
gimmemotifs Updated Posmo settings Dec 3, 2018
scripts user background => custom background, closes #49 Nov 27, 2018
src Remove meme from GimmeMotifs distribution Nov 27, 2018
test removed posmo from tests Dec 3, 2018
.gitattributes updated travis Jul 13, 2018
.gitignore API example Dec 5, 2018
.landscape.yaml ignoring these warnings for now. Apr 7, 2017
.rtd-environment.yml test for rtd Nov 20, 2018
.travis.yml updated travis config Dec 1, 2018
CHANGELOG.md updated CHANGELOG Dec 3, 2018
COPYING updated various files Jul 10, 2018
INSTALL updated various files Jul 10, 2018
MANIFEST.in API example Dec 5, 2018
README.md Update README.md Dec 5, 2018
compile_externals.py Remove meme from GimmeMotifs distribution Nov 27, 2018
conda_env.txt Suppress DeprecationWarnings so that numpy>1.13 works Jul 11, 2018
readthedocs.yml readthedocs Oct 26, 2018
requirements.txt fix for bdist_wheel Jul 13, 2018
run_tests.py
setup.cfg updated travis Jul 13, 2018
setup.py Remove meme from GimmeMotifs distribution Nov 27, 2018
versioneer.py updated travis Jul 13, 2018

README.md

GimmeMotifs

bioconda-badge PyPI version Build Status Code Health Documentation Status

DOI

Suite of motif tools, including a motif prediction pipeline for ChIP-seq experiments.

See full GimmeMotifs documentation for detailed installation instructions and usage examples.

For documentation on the development version see here.

The manuscript describing this latest release is available on biorRxiv as a preprint and can be cited as:

GimmeMotifs: an analysis framework for transcription factor motif analysis
Niklas Bruse, Simon J. van Heeringen
bioRxiv (2018) DOI: 10.1101/474403

You can interactively try out the Python API in a Jupyter notebook using binder: Binder

We need your help!

GimmeMotifs was originally developed for our own needs but we would really like it to be useful to the wider community. However, this also depends on your input. Let us know what you think! What features are missing? Which tutorial would you like to see? What part of the documentation is unclear? Have great ideas for future developments? Maybe you even want to join in developing this software?

Let us know!

Easy installation

The most straightforward way to install GimmeMotifs is via conda using the bioconda channel.

If you have not used bioconda before, first set up the necessary channels (in this order!). You only have to do this once.

$ conda config --add channels defaults
$ conda config --add channels bioconda
$ conda config --add channels conda-forge

You can now install GimmeMotifs with one command:

# Create an environment called gimme with all dependencies
$ conda create -n gimme python=3 gimmemotifs

# Activate the environment
$ conda activate gimme

Python 3 is the required, from version 0.13.0 on GimmeMotifs no longer supports Python 2. Don't forget to activate the environment with conda activate gimme whenever you want to use GimmeMotifs.

Quick start

Predict some motifs:

$ gimme motifs my_peaks.bed -g /data/genomes/hg38/hg38.fa -n my_motifs

Download a genome

The example above assumes that you have the hg38 genome in /data/genomes/hg38/hg38.fa. GimmeMotifs can also use genomes installed by genomepy.

You can configure the directory where genomepy stores genomes by editing ~/.config/genomepy/genomepy.yaml

genome_dir: /data/genomes

To download a genome from UCSC:

$ genomepy install hg38 UCSC --annotation

Now you can specify this genome for GimmeMotifs by name.

$ gimme motifs my_peaks.bed -g hg38 -n my_motifs

Help

You can’t perform that action at this time.