Skip to content

Commit 1e275f4

Browse files
mccallucpkerpedjiev
authored andcommitted
split up documentation (#74)
1 parent 5d0341b commit 1e275f4

File tree

13 files changed

+748
-747
lines changed

13 files changed

+748
-747
lines changed

COMMANDS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
### Converting tsv files to mrmatrix
22

3+
```
34
python scripts/tsv-to-mrmatrix.py data/dense.tsv data/dense.mrmatrix
5+
```
46

57
### Calculating gene coverage
68

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# Clodius <img src="https://travis-ci.org/hms-dbmi/clodius.svg?branch=develop"/>
22

3-
## Quick start without docker
3+
Displaying large amounts of data often requires first turning it into
4+
not-so-large amounts of data. Clodius is a program and library designed
5+
to aggregate large datasets to make them easy to display at different
6+
resolutions.
7+
8+
## Demo
49

510
Install the clodius package:
611

@@ -18,6 +23,21 @@ The output files can then be displayed using the [higlass-docker container](http
1823

1924
[More examples](COMMANDS.md) are available.
2025

26+
## File Types
27+
28+
- Non-genomic Rasters
29+
- [TSV Files](docs/raster/tsv.rst)
30+
- Genomic Data
31+
- [Bed Files](docs/genomic/bed.rst)
32+
- [BedGraph Files](docs/genomic/bedgraph.rst)
33+
- [Bedpe-like Files](docs/genomic/bedpe.rst)
34+
- [BigWig Files](docs/genomic/bigwig.rst)
35+
- [Chromosome Sizes](docs/genomic/chromosome-sizes.rst)
36+
- [Cooler Files](docs/genomic/cooler.rst)
37+
- [Gene Annotation](docs/genomic/gene-annotation.rst)
38+
- [HiTile Files](docs/genomic/hitile.rst)
39+
- [Multivec Files](docs/genomic/multivec.rst)
40+
2141
## Development
2242

2343

0 commit comments

Comments
 (0)