Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mberacochea committed Dec 1, 2022
1 parent 66c2bc2 commit 3f0b672
Show file tree
Hide file tree
Showing 14 changed files with 31 additions and 6 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,27 @@ $ bash run.sh \
#### Example

```bash
./run.sh \
-p $(pwd) \
-n test_catalogue \
-o $(pwd)/test_output \
-f $(pwd)/test_input \
-c $(pwd)/test_input/input_genomes.csv \
-x 1 \
-m 1000 \
-v "v1.0" \
-b "Test:test"

==== 1. dRep steps with cwltool [/test_output/test_catalogue/scripts/step1.test_catalogue.sh] ====
==== 2. mash2nwk submission script [/test_output/test_catalogue/scripts/step2.test_catalogue.sh] ====
==== 3. Cluster annotation [/test_output/test_catalogue/scripts/step3.test_catalogue.sh] ====
==== 4. mmseqs [/test_output/test_catalogue/scripts/step4.test_catalogue.sh] ====
==== 5. GTDB-Tk [/test_output/test_catalogue/scripts/step5.test_catalogue.sh] ====
==== 6. EggNOG, IPS, rRNA [/test_output/test_catalogue/scripts/step6.test_catalogue.sh] ====
==== 6a. Sanntis [/test_output/test_catalogue/scripts/step6a.test_catalogue.sh] ====
==== 7. Metadata and phylo.tree [/test_output/test_catalogue/scripts/step7.test_catalogue.sh] ====
==== 8. Post-processing [/test_output/test_catalogue/scripts/step8.test_catalogue.sh] ====
==== 9. Databases [/test_output/test_catalogue/scripts/step9.test_catalogue.sh] ====
==== 10. Re-structure [/test_output/test_catalogue/scripts/step10.test_catalogue.sh] ====
==== Final. Exit ====
```
14 changes: 8 additions & 6 deletions src/run.sh
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ MEM_STEP5="500G"
MEM_STEP6="50G"
MEM_STEP6a="5G"
MEM_STEP7="5G"
MEM_STEP8="5G"
MEM_STEP9="150G" # kraken needs 150G

THREADS_STEP1="16"
Expand All @@ -35,7 +34,6 @@ THREADS_STEP5="32"
THREADS_STEP6="16"
THREADS_STEP6a="1"
THREADS_STEP7="1"
THREADS_STEP8="1"
THREADS_STEP9="16"

usage() {
Expand All @@ -46,6 +44,7 @@ The generated scripts will run the pipeline step by step using cwltool / toil.
Use the -r option to generate and run the scripts (using bwait between steps).
OPTIONS:
-p Pipeline repo directory
-h Show help message
-t Threads. Default=4 [OPTIONAL]
-n Catalogue name
Expand All @@ -60,11 +59,10 @@ OPTIONS:
EOF
}

while getopts "h:n:f:c:m:x:v:b:o:q:r" OPTION; do
while getopts "p:n:f:c:m:x:v:b:o:q:r:h" OPTION; do
case $OPTION in
h)
usage
exit 1
p)
PIPELINE_DIRECTORY=${OPTARG}
;;
n)
NAME=${OPTARG}
Expand Down Expand Up @@ -96,6 +94,10 @@ while getopts "h:n:f:c:m:x:v:b:o:q:r" OPTION; do
r)
RUN=1
;;
h)
usage
exit 1
;;
?)
usage
exit 1
Expand Down
Empty file modified src/steps/10_restructure.sh
100644 → 100755
Empty file.
Empty file modified src/steps/1_drep.sh
100644 → 100755
Empty file.
Empty file modified src/steps/2_mash.sh
100644 → 100755
Empty file.
Empty file modified src/steps/3_process_clusters.sh
100644 → 100755
Empty file.
Empty file modified src/steps/4_create_files.sh
100644 → 100755
Empty file.
Empty file modified src/steps/4_mmseqs.sh
100644 → 100755
Empty file.
Empty file modified src/steps/5_gtdbtk.sh
100644 → 100755
Empty file.
Empty file modified src/steps/6_annotation.sh
100644 → 100755
Empty file.
Empty file modified src/steps/6a_run_sanntis.sh
100644 → 100755
Empty file.
Empty file modified src/steps/8_generate_yml.sh
100644 → 100755
Empty file.
Empty file modified src/steps/8_post_processing.sh
100644 → 100755
Empty file.
Empty file modified src/steps/9_databases.sh
100644 → 100755
Empty file.

0 comments on commit 3f0b672

Please sign in to comment.