Repository navigation
chore: one licence, a citation file, synthetic-data notes and a portable benchmark - #27
Merged
Merged
Conversation
…ble benchmark LICENSE holds the AGPL-3.0, so Cargo.toml, the README and the website now say so, a CITATION.cff names both authors, and check_site.py fails if any of them drifts. The example report says it is made from synthetic data, next to its title and next to every link to it. performance_benchmark.py times Recore on any pangenome given Recore's own inputs and replaces a benchmark tied to one local dataset.
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.
Preparation for making the repository public.
Licence
LICENSEholds the GNU Affero General Public License v3.0, soCargo.toml(AGPL-3.0-only), the README badge and footer, every website footer and the citation page now say so. The contributing guide states the licence instead of warning that the files disagree.tools/check_site.pyreadsLICENSEand fails ifCargo.toml,CITATION.cff, the README, the contributing guide or the website name another one.Citation file
CITATION.cffnames Paula Ruiz-Rodriguez and Mireia Coscolla with their ORCIDs and affiliation, for GitHub's "Cite this repository" button and for Zenodo. The version, release date and DOI go in on release day.Synthetic data, said everywhere the example report appears
tools/label_example_report.pyadds it after the report is regenerated.tools/check_site.pyfails on an example report without the note, or on a link to it that does not say its data are synthetic.A benchmark anyone can run
benchmarks/performance_benchmark.pytimes Recore on any pangenome, given the same inputs as Recore: wall time, peak memory of the process tree, temporary disk and output size. An optional Newick tree keeps only its tips, and--max-clusterskeeps a subset for a quick run. It replaces a benchmark that only ran on one local dataset. It was run on the tutorial dataset with the full profile, with a partial tree, with a cluster limit and without annotations, and gave Rescued 11 / Matrix-corrected 8 where the website says so.benchmarks/self_benchmark.pynow works in the system's temporary directory instead of a macOS path.Smaller things
tools/check_site.pyfails on MkDocs syntax left in the markdown..gitignoredrops an editor-specific entry.Every new check was broken on purpose and caught it. Locally fmt, clippy, the tests, the build,
check_site.py --run-tutorialand the auto-merge gate check all pass.