Skip to content

Commit

Permalink
Update cli.py
Browse files Browse the repository at this point in the history
update scan docstring
  • Loading branch information
LKremer authored Jun 15, 2022
1 parent 84aa114 commit e06d8b4
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions scbs/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -283,18 +283,18 @@ def smooth_cli(**kwargs):
@cli.command(
name="scan",
help=f"""
Scans the whole genome for regions of variable methylation. This works by sliding
a window across the genome, calculating the variance of methylation per window,
and selecting windows above a variance threshold.
Scans the whole genome for variably methylated regions (VMRs). This works by
sliding a window across the genome, calculating the variance of methylation per
window, and selecting windows above a variance threshold.
{style("DATA_DIR", fg="green")} is the directory containing the methylation
matrices produced by running 'scbs prepare', as well as the smoothed methylation
values produced by running 'scbs smooth'.
{style("OUTPUT", fg="green")} is the path of the output file in '.bed' format,
containing the variable windows that were found.
containing the VMRs that were found.
""",
short_help="Scan the genome to discover regions with variable methylation",
short_help="Scan the genome to discover variably methylated regions",
no_args_is_help=True,
)
@click.argument(
Expand All @@ -309,15 +309,17 @@ def smooth_cli(**kwargs):
type=click.IntRange(min=1, max=1e6),
metavar="INTEGER",
show_default=True,
help="Bandwidth of the variance windows in basepairs.",
help="Bandwidth of the variance windows in basepairs. Increase this ",
"value to find larger VMRs."
)
@click.option(
"--stepsize",
default=10,
type=click.IntRange(min=1, max=1e6),
metavar="INTEGER",
show_default=True,
help="Step size of the variance windows in basepairs.",
help="Step size of the variance windows in basepairs. Increase "
"this value to gain speed, at the cost of some accuracy.",
)
@click.option(
"--var-threshold",
Expand Down

0 comments on commit e06d8b4

Please sign in to comment.