Skip to content
Clodius is a tool for breaking up large data sets into smaller tiles that can subsequently be displayed using an appropriate viewer.
Python Jupyter Notebook Other
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
clodius
data Added raw data Apr 23, 2016
docs
notebooks
scripts Mccalluc/mrmatrix nan values at each resolution (#89) May 30, 2019
test
.bumpversion.cfg Bump version: 0.10.12 → 0.10.13 Jul 7, 2019
.dockerignore
.flake8
.gitignore
.travis.yml
CHANGELOG Update changelog Jul 7, 2019
COMMANDS.md split up documentation (#74) May 17, 2019
Dockerfile
LICENSE Initial commit Apr 22, 2016
MANIFEST.in Fix MANIFEST.in, remove MANIFEST Jul 7, 2019
Makefile Add makefile Jul 11, 2017
README.md split up documentation (#74) May 17, 2019
get_test_data.sh
pyprof.sh Added pyprof.sh May 31, 2016
requirements-dev.txt Update requirements files Jul 7, 2019
requirements.txt Update requirements files Jul 7, 2019
setup.py Bump version: 0.10.12 → 0.10.13 Jul 7, 2019
test.py
travis_test.sh Finish linting, except for unused local variables (#90) May 30, 2019

README.md

Clodius

Displaying large amounts of data often requires first turning it into not-so-large amounts of data. Clodius is a program and library designed to aggregate large datasets to make them easy to display at different resolutions.

Demo

Install the clodius package:

pip install clodius

And use it aggregate a bigWig file:

clodius aggregate bigwig ~/Downloads/E116-DNase.fc.signal.bigwig

The output files can then be displayed using the higlass-docker container. For more information about viewing these types of files take a look at the higlass wiki.

More examples are available.

File Types

Development

The recommended way to develop clodius is to use a conda environment and install clodius with develop mode:

python setup.py develop

Note that making changes to the clodius/fast.pyx cython module requires an explicit recompile step:

python setup.py build_ext --inplace

Testing

The unit tests for clodius can be run using nosetests:

nosetests test

Individual unit tests can be specified by indicating the file and function they are defined in:

nosetests test/cli_test.py:test_clodius_aggregate_bedgraph

Quick start with Docker

If you don't have your own, get some sample data:

mkdir -p /tmp/clodius/input
mkdir -p /tmp/clodius/output
curl https://raw.githubusercontent.com/hms-dbmi/clodius/develop/test/sample_data/geneAnnotationsExonsUnions.short.bed \
  > /tmp/clodius/input/sample.short.bed

Then install Docker, and pull and run the Clodius image:

docker stop clodius;
docker rm clodius;

docker pull gehlenborglab/clodius # Ensure that you have the latest.

docker run -v /tmp/clodius/:/tmp/ \
           gehlenborglab/clodius \
           clodius aggregate bigwig /tmp/input/file.bigwig

ls /tmp/clodius/output # Should contain the output file

If you already have a good location for your input and output files, reference that in the -v arguments above, instead of /tmp/clodius. The other scripts referenced below can be wrapped similarly.

You can’t perform that action at this time.