Skip to content

Commit

Permalink
Update output command-line description
Browse files Browse the repository at this point in the history
Fixes #241.
  • Loading branch information
bittremieux committed Dec 25, 2023
1 parent 3c2d3f5 commit dc757b9
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

## [Unreleased]

### Changed

- Update description of the `output` command-line argument to reflect that this is the root of the output (mzTab, log) files.

## [4.0.0] - 2023-12-22

### Added
Expand Down
15 changes: 10 additions & 5 deletions casanovo/casanovo.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,17 @@ def __init__(self, *args, **kwargs) -> None:
click.Option(
("-m", "--model"),
help="""
The model weights (.ckpt file). If not provided, Casanovo
will try to download the latest release.
The model weights (.ckpt file). If not provided, Casanovo will
try to download the latest release (during sequencing).
""",
type=click.Path(exists=True, dir_okay=False),
),
click.Option(
("-o", "--output"),
help="The mzTab file to which results will be written.",
help="The root file name to which results (i.e. the mzTab file "
"during sequencing, as well as the log file during all "
"modes) will be written. If not specified, a default "
"timestamped file name will be used.",
type=click.Path(dir_okay=False),
),
click.Option(
Expand Down Expand Up @@ -139,7 +142,7 @@ def sequence(
for peak_file in peak_path:
logger.info(" %s", peak_file)

runner.predict(peak_path, output)
runner.predict(peak_path, str(output))

logger.info("DONE!")

Expand Down Expand Up @@ -328,7 +331,7 @@ def setup_model(
config: Optional[str],
output: Optional[Path],
is_train: bool,
) -> Config:
) -> Tuple[Config, str]:
"""Setup Casanovo for most commands.
Parameters
Expand All @@ -347,6 +350,8 @@ def setup_model(
------
config : Config
The parsed configuration
model : str
The name of the model weights.
"""
# Read parameters from the config file.
config = Config(config)
Expand Down

0 comments on commit dc757b9

Please sign in to comment.