scholl-lab / plasmicheck

Detect and quantify plasmid DNA contamination in sequencing data
MIT License
0 stars 0 forks source link

Feature request: Clean Up and Expand `keep_intermediate` Flag in Pipeline #52

Closed berntpopp closed 3 months ago

berntpopp commented 3 months ago

Description:

The current keep_intermediate flag in the pipeline is intended to control whether intermediate files are retained after the pipeline execution. However, it does not currently cover all intermediate files generated throughout the pipeline. This can lead to unnecessary disk space usage and potential confusion for users expecting a clean output folder.

Expected Behavior:

Tasks:

  1. Identify All Intermediate Files: Review the entire pipeline to identify all intermediate files generated at different stages.
  2. Expand the keep_intermediate Logic:
    • Modify the pipeline to ensure that all identified intermediate files are deleted when keep_intermediate is set to false.
    • Ensure that no essential output files (final results) are removed in the process.
  3. Update Documentation:
    • Document the behavior of the keep_intermediate flag, listing the types of files that will be removed or retained based on the flag's value.
    • Provide examples and guidance for users on when to use this flag.

Acceptance Criteria:

Additional Information: