Add user guide page 19: reconstruction from KEGG - #40
Merged
Merged
Conversation
The second route to a draft with no template model: KEGG's orthology groups are already tied to reactions, so annotating a genome with KOs gives a draft directly. This page is marked skip-file, like the ftINIT one. A KEGG reconstruction downloads 47 MB of artefacts and takes about six minutes to assemble even once they are cached, which is too much for a per-commit check. Every number quoted was measured, and the page says plainly that it is not executed by CI. The MATLAB tab documents a failure rather than a model. getKEGGModelForOrganism cannot complete: keggModel.mat is not in the repository and neither remedy its error message names provides it -- downloadRavenBinaries fetches only the three executables, and raven-toolbox has no reference to keggModel at all. It also downloads the 129 MB HMM library first, on a route that performs no homology search. Filed as SysBioChalmers/RAVEN#704. The Python route works and gives 1357 reactions, 1502 metabolites and 838 genes for sce -- in a single compartment, with no exchanges and no objective, which is what 19.3 is about.
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.
Adds user guide page 19, Reconstruction from KEGG — the route to a draft with
no template model, where orthology groups carry the reactions.
This page is not executed by CI
It carries
skip-file, as the ftINIT page does. A KEGG reconstruction fetches47 MB of artefacts and then takes about six minutes to assemble the draft —
and the download is not the slow part, so caching does not help. That is too much
for a per-commit check. Every number on the page was measured on a real run, and
the page says in its second paragraph that it is not executed, rather than
letting a reader assume the guide's usual guarantee holds.
The MATLAB tab documents a failure
getKEGGModelForOrganismcannot currently complete, so the tab shows the errorinstead of a model:
Neither remedy the message names exists:
downloadRavenBinariesfetches only{'blast+','diamond','hmmer'}by its own help, and raven-toolbox has noreference to
keggModelanywhere insrc/ordocs/. The file is not in therepository and
updateDocumentationdeletes it if present. Filed asRAVEN#704, together with
two things met on the way: the 129 MB HMM library downloads even on this route,
which performs no homology search at all; and
findRAVENrootprefers a storedRAVEN.ravenPathpreference over the copy actually executing, so on a machinewith two checkouts the error names a directory the user is not working in.
What the Python route gives
One compartment, because KEGG describes reactions rather than cell biology. 19.3
is about that gap and about the
keepIncomplete/keepUndefinedStoich/keepGeneralflags — turning the first two off drops the draft to 1348 reactionsand 827 genes, a smaller change than most people expect.
Checks
check_names.pyclean (eleven argument names added to the allowlist)The guide is now 19 pages. 185 examples still execute on every commit; pages 10
and 19 are the two that cannot.