Skip to content

Commit 9632d8f

Browse files
committed
[refine] update help messages
The previous messaging ("default: None") implied that no tree/node-data JSON would be created, which isn't the case.
1 parent a087552 commit 9632d8f

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

augur/refine.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
import sys
66
from Bio import Phylo
77
from textwrap import dedent
8-
from .argparse_ import ExtendOverwriteDefault
8+
from .argparse_ import ExtendOverwriteDefault, SKIP_AUTO_DEFAULT_IN_HELP
99
from .dates import get_numerical_dates
1010
from .dates.errors import InvalidYearBounds
1111
from .io.metadata import DEFAULT_DELIMITERS, DEFAULT_ID_COLUMNS, METADATA_DATE_COLUMN, InvalidDelimiter, Metadata, read_metadata
@@ -174,8 +174,8 @@ def register_parser(parent_subparsers):
174174
help="delimiters to accept when reading a metadata file. Only one delimiter will be inferred.")
175175
parser.add_argument('--metadata-id-columns', default=DEFAULT_ID_COLUMNS, nargs="+", action=ExtendOverwriteDefault,
176176
help="names of possible metadata columns containing identifier information, ordered by priority. Only one ID column will be inferred.")
177-
parser.add_argument('--output-tree', type=str, help='file name to write tree to')
178-
parser.add_argument('--output-node-data', type=str, help='file name to write branch lengths as node data')
177+
parser.add_argument('--output-tree', type=str, help='file name to write tree to. If not provided a file will be created using the alignment or tree input path with a "_tt.nwk" suffix.'+SKIP_AUTO_DEFAULT_IN_HELP)
178+
parser.add_argument('--output-node-data', type=str, help='file name to write branch lengths as node data. If not provided a file will be created using the alignment or tree input path with a ".node_data.json" suffix.'+SKIP_AUTO_DEFAULT_IN_HELP)
179179
parser.add_argument('--use-fft', action="store_true", help="produce timetree using FFT for convolutions")
180180
parser.add_argument('--max-iter', default=2, type=int, help="maximal number of iterations TreeTime uses for timetree inference")
181181
parser.add_argument('--timetree', action="store_true", help="produce timetree using treetime, requires tree where branch length is in units of average number of nucleotide or protein substitutions per site (and branch lengths do not exceed 4)")

0 commit comments

Comments
 (0)