Commit 19a68da0 authored by Miroslav Kratochvil's avatar Miroslav Kratochvil
Browse files

explain the multi-gene knockouts better

Fixes #520

A complete fix might be better in the future (see #552).
parent ea0cce13
Pipeline #51181 passed with stages
in 11 minutes and 41 seconds
......@@ -2,7 +2,19 @@
knockout(gene_ids::Vector{String})
A modification that zeroes the bounds of all reactions that would be knocked
out by the specified genes (effectively disables the reactions).
out by the combination of specified genes (effectively disabling the
reactions).
A slightly counter-intuitive behavior may occur if knocking out multiple genes:
Because this only changes the reaction bounds, multiple gene knockouts _must_
be specified in a single call to [`knockout`](@ref), because the modifications
have no way to remember which genes are already knocked out and which not.
In turn, having a reaction that can be catalyzed either by Gene1 or by Gene2,
specifying `modifications = [knockout(["Gene1", "Gene2"])]` does indeed disable
the reaction, but `modifications = [knockout("Gene1"), knockout("Gene2")]` does
_not_ disable the reaction (although reactions that depend either only on Gene1
or only on Gene2 are disabled).
"""
knockout(gene_ids::Vector{String}) =
(model, optmodel) -> _do_knockout(model, optmodel, gene_ids)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment