Repository navigation
Conversation
Adds paper/paper.md (Whedon-format draft seeded from the README statement of need), paper/paper.bib (six seed entries flagged for DOI verification), and paper/INSTRUCTIONS.md for collaborators. Gates: - tests/test_paper.py: front matter, citation resolution, and JOSS word budgets, running in CI (python-test), as the paper-checks pre-commit hook, and via make paper-check - .github/workflows/paper.yml: path-filtered compile of paper.pdf from the JOSS paperdraft resources, uploaded as an artifact - Makefile: paper-check / paper-image / paper-pdf / paper targets The paperdraft build patches the archived whedon sources (registry-qualified base image, frozen TeXLive 2021 repo, vestigial biblatex strip); the Makefile and workflow versions must stay in sync.
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: true
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
test_docs_source_of_truth requires every .PHONY Makefile target in the CONTRIBUTING.md Task runner table and every workflow described once in the llms.txt GitHub Workflows entry with matching purpose terms; paper.yml's compile step now names itself a test build so the entry reads naturally.
Owner
Author
|
@jaredroach and @gglusman this is where we're supposed to work on and edit the JOSS paper for Tablassert. I still need to scaffold out the paper but I'd imagine us here commenting. Making edits as commits to this branch, etc... I'll update y'all here when I do anything |
Replaces the scaffold's TODO seed text with a complete draft across all JOSS-required sections (Summary, Statement of need, State of the field, Software design, Research impact statement, AI usage disclosure stub, Acknowledgements stub, References). Research impact states lineage facts with status caveats: MicrobiomeKG precursor use, current MOKG builds, DAKP releases, pending translator-ingests integration, KRAKEN graph consumption, rare-disease graph in preparation. paper.bib: every published entry re-verified against Crossref/arXiv/ bioRxiv or upstream CITATION.cff/release metadata; replaces four wrong scaffold DOIs (biolink-model, translator, babel, kgx) and fixes the MicrobiomeKG author order; adds koza, redb, kraken, dakp, drug-approvals, ingests entries. Gates: paper-check now enforces the JOSS-required section list and the official 750-1750 word body budget (scaffold capped at a self-imposed 1000); markdownlint overrides MD025 for paper/paper.md because the JOSS template puts every section at heading level 1. Verified: pytest full suite 1229 passed, pyright clean, ruff clean, markdownlint clean, html-validate clean, paper.pdf compiles to 3 pages with resolved citations.
… field Front matter now uses the JOSS affiliation-index convention with an affiliations list; the previous full-string affiliations made authblk collapse the rendered author block to the last author (verified in the compiled PDF). KGX is cited with title only since it has no CITATION.cff or registry-verified author list. CITATION.cff author order updated to match.
This branch has not been deployed
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
Scaffolds the JOSS paper in
paper/(tracked, not ignored) and wires it into the repo's gates:paper/paper.md: Whedon-format draft, seeded from the README statement of needpaper/paper.bib: six seed entriespaper/INSTRUCTIONS.md: collaborator guidance (word budgets, figures, submission flow)tests/test_paper.py: front matter / citation resolution / word-budget gate (runs in CIpython-test, as thepaper-checkspre-commit hook, and viamake paper-check).github/workflows/paper.yml: path-filtered compile ofpaper.pdffrom the JOSS paperdraft resources, uploaded as a PR artifactMakefile:paper-check/paper-image/paper-pdf/paperVerified locally:
make papercompiles a valid PDF with resolved citations;make paper-pdfis idempotent (stamp + Docker layer cache); the Paper workflow will run on this PR sincepaper/**changed.Checklist before submission to review-joss
TODO(collaborators)section inpaper/paper.md(Statement of need, State of the field, Acknowledgements)% TODO: verifyentry inpaper/paper.bib(title, authors, year, DOI)paper/figures/and uncomment the Figures placeholderCITATION.cff)make paperpasses locallyNotes
paper-imagebuilds the paperdraft image from the archived (frozen 2024-04-16) openjournals/whedon sources with three patches (registry-qualified base, frozen TeXLive 2021 repo, vestigial biblatex strip). Makefile and workflow copies must stay in sync.paper/*.pdfand.paperdraft/are git-ignored.