Skip to content

Commit 291bff0

Browse files
committed
docs: update tutorial about integration with Chewie-NS to separate commands to run from the expected output.
1 parent 006f0a2 commit 291bff0

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CHEWBBACA/docs/user/tutorials/chewieNS_step_by_step.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ To upload the schema included in the *Streptococcus agalactiae* dataset, you can
8383

8484
$ chewBBACA.py LoadSchema -i sagalactiae_schema/ -sp 1 -sn tut -lp tut --df sagalactiae_description.md --a sagalactiae_annotations.tsv --ns tutorial
8585

86+
::
87+
8688
==========================
8789
chewBBACA - LoadSchema
8890
==========================
@@ -171,6 +173,8 @@ To download the schema you have uploaded, please run the following command:
171173

172174
$ chewBBACA.py DownloadSchema -sp 1 -sc 1 -o sagalactiae_ns --ns tutorial
173175

176+
::
177+
174178
==============================
175179
chewBBACA - DownloadSchema
176180
==============================
@@ -207,6 +211,8 @@ To perform allele call and determine the allelic profiles of the genomes in the
207211

208212
$ chewBBACA.py AlleleCall -i sagalactiae_genomes/subset1/ -g sagalactiae_ns/Streptococcus_agalactiae_tut/ -o subset1_results
209213

214+
::
215+
210216
==========================
211217
chewBBACA - AlleleCall
212218
==========================
@@ -372,6 +378,8 @@ Running the ``SyncSchema`` process is fairly simple. To retrieve new alleles add
372378

373379
$ chewBBACA.py SyncSchema -sc sagalactiae_ns/Streptococcus_agalactiae_tut/ --submit
374380

381+
::
382+
375383
==========================
376384
chewBBACA - SyncSchema
377385
==========================
@@ -446,6 +454,8 @@ A sample command would be:
446454

447455
$ chewBBACA.py DownloadSchema -sp 1 -sc 1 -o sagalactiae_snapshot --ns tutorial --d "2020-08-07T22:47:52"
448456

457+
::
458+
449459
==============================
450460
chewBBACA - DownloadSchema
451461
==============================
@@ -486,6 +496,8 @@ We will perform allele call with the genomes in subset2 to demonstrate how the `
486496

487497
$ chewBBACA.py AlleleCall -i sagalactiae_genomes/subset2/ -g sagalactiae_snapshot/Streptococcus_agalactiae_tut/ -o subset2_results
488498

499+
::
500+
489501
...
490502

491503
Classified a total of 75 CDSs.
@@ -512,6 +524,8 @@ To perform this last synchronization, execute:
512524

513525
$ chewBBACA.py SyncSchema -sc sagalactiae_snapshot/Streptococcus_agalactiae_tut/ --submit
514526

527+
::
528+
515529
...
516530

517531
Received 47 new alleles for 7 loci and sent 33 for 7 loci.

0 commit comments

Comments
 (0)