Log.out and Log.progress.out#82
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
feat: write
Log.outandLog.progress.outCloses #55.
Summary
rustar-aligner was writing only
Log.final.out. STAR writes two additional log files thatpipeline tools (nf-core/rnaseq, MultiQC, custom QC dashboards) consume for provenance,
progress monitoring, and run validation. Both files are now written with real content —
not stubs or debug dumps.
Files written
Log.out— mirrors STAR's verbose run log:STAR version=, compilation time)##### Initial USER parameters from Command Line###### All USER parameters from Command Line(with~RE-DEFINEDmarkers)##### Final user re-defined parameters+ reconstructed effective command lineindex name length start— real values from the loaded genome)ALL DONE!Log.progress.out— mirrors STAR's periodic alignment progress log:average read length, unique mapped, average mapped length, multi-mapper rate, multi count,
mismatch-filtered, too-short, and other unmapped
ALL DONE!Implementation
New module
src/io/log.rswith two public functions:write_log_out(path, params, genome, time_start, time_genome_loaded, time_finish)write_log_progress_out(path, stats, time_start, time_finish)cli_params()helper parsesparams.command_line(already captured for the@PGBAMheader by PR #40) into
(name, value)pairs for the parameter sections.lib.rschanges:time_genome_loadedtimestamp immediately afterGenomeIndex::loadLog.final.outat the end ofalign_readsTest plan
cargo test— 434 tests passing, 0 failurescargo clippy --all-targets— 0 warningscargo fmt --check— cleanLog*.outfiles present in output directory;Log.outcontains real command line, chromosome table, and
ALL DONE!;Log.progress.outcontains STAR header, a stats line with real read counts, and
ALL DONE!