Skip to content

chore(oi2): pin defaults, docs#460

Open
tristan-f-r wants to merge 1 commit intoReed-CompBio:mainfrom
tristan-f-r:oi2-more-docs
Open

chore(oi2): pin defaults, docs#460
tristan-f-r wants to merge 1 commit intoReed-CompBio:mainfrom
tristan-f-r:oi2-more-docs

Conversation

@tristan-f-r
Copy link
Collaborator

I was very confused by what 'corrupted data' meant in OI2. Hopefully this saves the next reader some time digging through the OmicsIntegrator2 codebase.

While we're here, we also pin the defaults using values provided by OI2, and move dummy_mode documentation over to the enum instead of on the parameter class directly.

@tristan-f-r tristan-f-r added the documentation Improvements or additions to documentation label Feb 24, 2026
@read-the-docs-community
Copy link

Documentation build overview

📚 spras | 🛠️ Build #31542754 | 📁 Comparing f1ce94d against latest (479842d)


🔍 Preview build

Show files changed (6 files in total): 📝 5 modified | ➕ 0 added | ➖ 1 deleted
File Status
genindex.html 📝 modified
fordevs/modules.html 📝 modified
fordevs/spras.config.html 📝 modified
fordevs/spras.html 📝 modified
prms/diamond.html ➖ deleted
prms/prms.html 📝 modified

Comment on lines +196 to +198
# We get protein1, protein2, and cost if no edges were inside the solution,
# and we get protein1, protein2 if no edges were present in the augmented forest at all:
# both of these outcomes should be treated as an empty network.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ntalluri there were multiple OI2 failure modes you observed. Can you please confirm this comment is accurate with respect to your past tests?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants