Skip to content

Commit

Permalink
update help text
Browse files Browse the repository at this point in the history
  • Loading branch information
jsstevenson committed Aug 30, 2024
1 parent 4a20798 commit 204bc6a
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions src/ga4gh/vrs/extras/vcf_annotation.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,29 +46,29 @@ class SeqRepoProxyType(str, Enum):
"--vcf_out",
required=False,
type=click.Path(writable=True, allow_dash=False, path_type=pathlib.Path),
help=("The path for the output VCF file. If not provided, must provide "
help=("Declare save location for output annotated VCF. If not provided, must provide "
"--vrs_pickle_out.")
)
@click.option(
"--vrs_pickle_out",
required=False,
type=click.Path(writable=True, allow_dash=False, path_type=pathlib.Path),
help=("The path for the output VCF pickle file. If not provided, must provide "
"--vcf_out")
help=("Declare save location for output VCF pickle. If not provided, must provide "
"--vcf_out.")
)
@click.option(
"--vrs_attributes",
is_flag=True,
default=False,
help="Will include VRS_Start, VRS_End, VRS_State fields in the INFO field.",
help="Include VRS_Start, VRS_End, and VRS_State fields in the VCF output INFO field.",
)
@click.option(
"--seqrepo_dp_type",
required=False,
default=SeqRepoProxyType.LOCAL,
type=click.Choice([v.value for v in SeqRepoProxyType.__members__.values()],
case_sensitive=True),
help="The type of the SeqRepo Data Proxy to use",
help="Specify type of SeqRepo dataproxy to use.",
show_default=True,
show_choices=True
)
Expand All @@ -77,22 +77,22 @@ class SeqRepoProxyType(str, Enum):
required=False,
default=pathlib.Path("/usr/local/share/seqrepo/latest"),
type=click.Path(path_type=pathlib.Path),
help="The root directory for local SeqRepo instance",
help="Define root directory for local SeqRepo instance, if --seqrepo_dp_type=local.",
show_default=True
)
@click.option(
"--seqrepo_base_url",
required=False,
default="http://localhost:5000/seqrepo",
help="The base url for SeqRepo REST API",
help="Specify base URL for SeqRepo REST API, if --seqrepo_dp_type=rest.",
show_default=True
)
@click.option(
"--assembly",
required=False,
default="GRCh38",
show_default=True,
help="The assembly that the `vcf_in` data uses.",
help="Specify assembly that was used to create VCF at `vcf_in`.",
type=str
)
@click.option(
Expand All @@ -105,7 +105,7 @@ class SeqRepoProxyType(str, Enum):
"--require_validation",
is_flag=True,
default=False,
help="Require validation checks to pass in order to return a VRS object"
help="Require validation checks to pass to annotate a record with a VRS object."
)
def annotate_click( # pylint: disable=too-many-arguments
vcf_in: pathlib.Path, vcf_out: Optional[pathlib.Path], vrs_pickle_out: Optional[pathlib.Path],
Expand Down

0 comments on commit 204bc6a

Please sign in to comment.