Repository navigation
Point the docs at main, and give Docker runs a writable home - #15
Merged
Merged
Conversation
Eight links in the docs, and every page's Edit this page button, pointed at indel-mask, a branch merged and deleted since, so they led nowhere. They now point at main. Under the docker profile the container runs as the invoking user, who has no home in the image: HOME was / and read-only, so genmap, MultiQC and Java could not keep their settings, and genmap's version was recorded as a mkdir error. The profile now sets HOME=/tmp. The outputs page said that where a SNP's codon_change is filled, its aa_change is what the base names alone. The first end-to-end run showed otherwise: by default the matrix reads FreeBayes' raw VCF, where two changes of one codon on the same reads are one record annotated as the codon they make, so aa_change already names it. The page and the report's help now say which VCF gives which.
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.
What changed and why
Three small fixes found while working on #13 and #14.
edit_uriinmkdocs.yml), pointed atindel-mask, a branch merged and deleted since. They now point atmain, and every target was checked to exist there.HOMEunder thedockerprofile. The container runs as the invoking user (-u $(id -u):$(id -g)), who has no home in the image. SoHOMEwas/and read-only: genmap, MultiQC and Java could not keep their settings, andsoftware_versions.txtrecorded genmap'smkdirerror as its version (seen in the first end-to-end run of Run the pipeline for real in CI, on a cohort whose truth is known #14). The profile now adds-e HOME=/tmp.aa_changeholds in the SNP matrix.outputs.mdsaid that wherecodon_changeis filled,aa_changeis what the base names alone. The first complete end-to-end run of Run the pipeline for real in CI, on a cohort whose truth is known #14 showed otherwise. By default the matrix reads FreeBayes' annotated raw VCF, where two changes of one codon on the same reads are one record annotated as the codon they make (CAC>GAG gives His145Glu on both bases). The page now says which VCF gives which, and the report's help no longer implies that a row's own change is per base.Outputs and defaults
dockergenmap's version is recorded rather than an error.How it was verified
HOME. The end-to-end job that would exercise it is in Run the pipeline for real in CI, on a cohort whose truth is known #14; once that merges, every pull request runs it.Checklist
tests/run_tests.shpasses: lint, unit and js locally; the pipeline leg in CI (a config-only change there, whose container tests pass locally)ruff check .is clean, and I did not restyle code the change does not touchHOMEchange is held by Run the pipeline for real in CI, on a cohort whose truth is known #14's end-to-end check on genmap's version once both are in)modules/has astub:block, and-profile test_fullreaches it (not applicable: no new process)tests/data/was not edited by handCHANGELOG.mdentry and, where relevant, a docs update