Skip to content

Commit dd2f227

Browse files
committed
updated
1 parent c02e906 commit dd2f227

File tree

2 files changed

+25
-10
lines changed

2 files changed

+25
-10
lines changed

docs/damid.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,10 @@ DamID principle
1111
Experimental considerations
1212
---------------------------
1313

14-
#. Make sure that you sequence validated your Dam expressing plasmids prior to your experiment. Cryptic expression of Dam can cause toxicity in *E. coli* and can cause selection for Dam inactivating mutations.
14+
#. Make sure that you have sequence validated your Dam expressing plasmids prior to your experiment. Cryptic expression of Dam can cause toxicity in *E. coli* and can cause selection for Dam inactivating mutations.
15+
16+
17+
Critical reagents
18+
-----------------
19+
20+
TO DO

docs/index.rst

+18-9
Original file line numberDiff line numberDiff line change
@@ -8,54 +8,63 @@
88
.. image:: https://img.shields.io/github/stars/niekwit/damid-seq?style=social
99
:alt: GitHub stars
1010

11+
1112
damid-seq
1213
=========
1314

14-
`damid-seq` is a (containerized) Snakemake pipeline for reproducible analysis of single/paired-end DamID-seq short read Illumina data.
15+
`damid-seq` is a containerized Snakemake pipeline for reproducible analysis of single/paired-end DamID-seq short read Illumina data.
1516

1617
The core of the pipeline is the Perl script `damidseq_pipeline <https://github.com/owenjm/damidseq_pipeline>`_, which is a great tool for the first steps of analysing DamID-seq data. However, it does not process biological replicate data, and is not written with deployment to server, cluster, grid and cloud environments in mind.
1718

1819

1920
Aim
2021
---
2122

22-
`damid-seq` implements the [Snakemake](https://snakemake.readthedocs.io/en/stable/) workflow management system, which overcomes the above issues. In addition, we have added many features to the DamID-seq analysis workflow.
23+
`damid-seq` implements the `Snakemake <https://snakemake.readthedocs.io/en/stable/>`_ workflow management system, which overcomes the above issues. In addition, we have added many features to the DamID-seq analysis workflow.
24+
2325

24-
**CONTENTS**
26+
**Contents**
2527
------------
2628

2729
.. toctree::
2830
:caption: DamID
29-
:maxdepth: 2
31+
:maxdepth: 1
3032

3133
damid.rst
3234

3335
.. toctree::
3436
:caption: Installation
35-
:maxdepth: 2
37+
:maxdepth: 1
3638

3739
installation.rst
3840

3941
.. toctree::
4042
:caption: Usage
41-
:maxdepth: 2
43+
:maxdepth: 1
4244

4345
usage.rst
4446

4547
.. toctree::
4648
:caption: Output
47-
:maxdepth: 2
49+
:maxdepth: 1
4850

4951
output.rst
5052

5153
.. toctree::
5254
:caption: Citation
53-
:maxdepth: 2
55+
:maxdepth: 1
5456

5557
citation.rst
5658

5759
.. toctree::
5860
:caption: Literature
59-
:maxdepth: 2
61+
:maxdepth: 1
6062

6163
literature.rst
64+
65+
66+
.. toctree::
67+
:caption: Source code
68+
:maxdepth: 1
69+
70+
sourcecode.rst

0 commit comments

Comments
 (0)