Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[export] Improve root-sequence help messages #1478

Merged
merged 1 commit into from
Jun 5, 2024
Merged

[export] Improve root-sequence help messages #1478

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions augur/export_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -920,12 +920,22 @@ def register_parser(parent_subparsers):
minify_group.add_argument('--minify-json', action="store_true", help="always export JSONs without indentation or line returns.")
minify_group.add_argument('--no-minify-json', action="store_true", help="always export JSONs to be human readable.")

root_sequence_group = parser.add_argument_group(
title="OPTIONAL ROOT-SEQUENCE SETTINGS",
description=f"""
The root-sequences describe the sequences (nuc + aa) for the parent of the tree's root-node. They may represent a
reference sequence or the inferred sequence at the root node, depending on how they were generated.
The data is taken directly from the `reference` key within the provided node-data JSONs.
These arguments are mutually exclusive.
"""
).add_mutually_exclusive_group()
root_sequence = root_sequence_group.add_mutually_exclusive_group()
root_sequence.add_argument('--include-root-sequence', action="store_true", help="Export as an additional JSON. The filename will follow the pattern of <OUTPUT>_root-sequence.json for a main auspice JSON of <OUTPUT>.json")
root_sequence.add_argument('--include-root-sequence-inline', action="store_true", help="Export the root sequence within the dataset JSON. This should only be used for small genomes for file size reasons.")

optional_settings = parser.add_argument_group(
title="OTHER OPTIONAL SETTINGS"
)
root_sequence = optional_settings.add_mutually_exclusive_group()
root_sequence.add_argument('--include-root-sequence', action="store_true", help="Export an additional JSON containing the root sequence (reference sequence for vcf) used to identify mutations. The filename will follow the pattern of <OUTPUT>_root-sequence.json for a main auspice JSON of <OUTPUT>.json")
root_sequence.add_argument('--include-root-sequence-inline', action="store_true", help="Export the root sequence (reference sequence for vcf) used to identify mutations as part of the main dataset JSON. This should only be used for small genomes for file size reasons.")
optional_settings.add_argument(
'--validation-mode',
dest="validation_mode",
Expand Down
Loading