annotate README.rst @ 1:1bc1199f0ff4 draft

"planemo upload for repository https://github.com/usegalaxy-au/tools-au commit b88790af695dae9aff51232d799f5d8786881bbd"
author galaxy-australia
date Wed, 22 Jun 2022 00:58:50 +0000
parents 85f68b344286
children 8b67dd48fec1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
1 Cactus
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
2 ======
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
3
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
4 This suite contains a wrapper for the
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
5 `Cactus <github.com/comparativeGenomicsToolkit/cactus>`__ whole-genome
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
6 aligner and another wrapper for exporting the data it generates.
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
7
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
8 Requirements
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
9 ------------
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
10
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
11 The developers provide an official Docker container. However, the Docker
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
12 container won’t run unless ``/etc/passwd`` is mounted (`see this
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
13 issue <https://github.com/ComparativeGenomicsToolkit/cactus/issues/677>`__).
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
14 Because of this, it is recommended to run Cactus using Singularity.
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
15
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
16 Cactus uses a lot of RAM. We have tested it on Galaxy using 24 GB of RAM
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
17 for a progressive alignment of three chromosome-level, 150 megabase
85f68b344286 "planemo upload for repository https://github.com/usegalaxy-au/tools-au commit 8f8363625623f2ff3f04d12d227673ac134eba24"
galaxy-australia
parents:
diff changeset
18 genomes.