Skip to content

Feat separate winnow predict filtered dataset outputs#131

Merged
JemmaLDaniel merged 2 commits into
mainfrom
feat-separate-predict-outputs
Nov 3, 2025
Merged

Feat separate winnow predict filtered dataset outputs#131
JemmaLDaniel merged 2 commits into
mainfrom
feat-separate-predict-outputs

Conversation

@JemmaLDaniel
Copy link
Copy Markdown
Collaborator

Feature: Separate metadata and features from predictions and FDR metrics in CLI output

Summary

Implements a feature to separate outputs from winnow predict into two CSV files: one containing metadata and features, and another containing predictions and FDR metrics. This improves usability for downstream analysis by allowing users to work with different output categories independently.

Changes

Implementation (winnow/scripts/main.py)

  • Changed parameter: Renamed --output-path to --output-folder to better reflect that multiple files are written
  • Added output separation logic: The predict command now:
    1. Separates columns into two groups:
      • Metadata/features: All original metadata and feature columns
      • Predictions/FDR metrics: spectrum_id, confidence scores, prediction, psm_fdr, psm_q_value, psm_pep (if winnow method), and sequence (if available)
    2. Writes two separate CSV files:
      • metadata.csv: Contains all metadata and feature columns
      • preds_and_fdr_metrics.csv: Contains predictions and error metrics

Documentation Updates (docs/cli.md)

  • Updated winnow predict output section to describe the two-file output structure
  • Fixed parameter name from --output-path to --output-folder in all examples
  • Added detailed descriptions of columns in each output file
  • Updated workflow examples to use the correct parameter names

Files Changed

  • winnow/scripts/main.py: Implemented output separation logic and changed parameter name
  • docs/cli.md: Updated documentation to reflect the new two-file output structure

Breaking Changes

This is a breaking change for users of the CLI:

  • The --output-path parameter has been renamed to --output-folder
  • Instead of a single CSV file, two files are now created: metadata.csv and preds_and_fdr_metrics.csv
  • Users will need to update scripts/workflows to read from the new file structure

@JemmaLDaniel JemmaLDaniel self-assigned this Oct 29, 2025
@JemmaLDaniel JemmaLDaniel added the enhancement New feature or request label Oct 29, 2025
@BioGeek BioGeek self-requested a review October 31, 2025 16:02
Copy link
Copy Markdown
Contributor

@BioGeek BioGeek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@JemmaLDaniel JemmaLDaniel merged commit 40ed622 into main Nov 3, 2025
5 checks passed
@JemmaLDaniel JemmaLDaniel linked an issue Nov 14, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: Separate saved outputs into features and FDR metrics

2 participants