Skip to content

Commit

Permalink
Updated README.md and CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kbessonov1984 committed Oct 1, 2024
1 parent 5d9744f commit 929bbbe
Showing 1 changed file with 28 additions and 27 deletions.
55 changes: 28 additions & 27 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -293,12 +293,38 @@ Summary of output options:

Primary results output (``-o sistr-results``)
---------------------------------------------
SISTR supports various output formats specified by the ``-f`` with ``json`` being the default.
SISTR supports various text output formats specified by the ``-f`` option with ``json`` being the default.

JSON results output (``-f json``):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: json
[
{
"serovar_cgmlst": "Typhimurium",
"cgmlst_matching_alleles": 327,
"h1": "i",
"serovar_antigen": "Typhimurium",
"cgmlst_distance": 0.009090909090909038,
"h2": "1,2",
"cgmlst_genome_match": "LT2",
"cgmlst_ST": 660408169,
"serovar": "Typhimurium",
"fasta_filepath": "/full/path/to/LT2.fasta",
"genome": "LT2",
"serogroup": "B",
"qc_messages": "",
"qc_status": "PASS",
"o_antigen": "1,4,[5],12",
"cgmlst_subspecies": "enterica"
}
]
Tab-delimited results output (``-f tab``):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: tab
.. code-block:: text
cgmlst_ST cgmlst_distance cgmlst_genome_match cgmlst_matching_alleles cgmlst_subspecies fasta_filepath genome h1 h2 o_antigen qc_messages qc_status serogroup serovar serovar_antigen serovar_cgmlst
660408169 0.00909090909091 LT2 327 enterica /home/peter/Downloads/sistr-LT2-example/LT2.fasta LT2 i 1,2 1,4,[5],12 PASS B Typhimurium Typhimurium Typhimurium
Expand All @@ -320,31 +346,6 @@ The same ``csv`` results rendered as a table
660408169,0.00909090909091,LT2,327,enterica,/home/peter/Downloads/sistr-LT2-example/LT2.fasta,LT2,i,"1,2","1,4,[5],12",,PASS,B,Typhimurium,Typhimurium,Typhimurium


JSON results output:
~~~~~~~~~~~~~~~~~~~~
.. code-block:: json
[
{
"serovar_cgmlst": "Typhimurium",
"cgmlst_matching_alleles": 327,
"h1": "i",
"serovar_antigen": "Typhimurium",
"cgmlst_distance": 0.009090909090909038,
"h2": "1,2",
"cgmlst_genome_match": "LT2",
"cgmlst_ST": 660408169,
"serovar": "Typhimurium",
"fasta_filepath": "/full/path/to/LT2.fasta",
"genome": "LT2",
"serogroup": "B",
"qc_messages": "",
"qc_status": "PASS",
"o_antigen": "1,4,[5],12",
"cgmlst_subspecies": "enterica"
}
]
cgMLST allele search results
-------------------------------------

Expand Down

0 comments on commit 929bbbe

Please sign in to comment.