docs: prepare JOSE review materials#5
Draft
AurelienNicosiaULaval wants to merge 10 commits into
Draft
Conversation
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.
Summary
Prepare
tutorizeRfor a future JOSE review as open-source educational infrastructure, not merely as a JOSS/CRAN readiness pass.Scope
paper/paper.mdas a JOSE-oriented software paper with cautious educational claims.docs/educational_use_evidence.md,docs/jose_review_checklist.md,docs/jose_submission_guide.md,docs/jose_blockers_report.md,docs/jose_release_bundle.md, anddocs/jose_pr_final_report.md.inst/examples/example_course_module/as an installable teaching example with source lesson, question bank, expected outputs, report, andrun-example.R.vignettes/teaching-workflow-case-study.Rmdand expands core vignettes for JOSE review.LICENSE-CONTENT.mdfor CC-BY 4.0 educational content and figure licensing.Validation
Validated locally on 2026-05-31:
Rscript -e "testthat::test_local('.')": PASS, 144 tests.Rscript -e "lintr::lint_package()": PASS, no lints._pkgdown.ymlparsed withyaml::read_yaml(): PASS.paper/paper.mdrendered with bibliography resolution: PASS.run-example.Rworks after local package load: PASS.R CMD build: PASS.R CMD check --as-cran --no-manual: PASS with 1 NOTE for new submission.GitHub Actions on the latest PR head passed:
Run: https://github.com/AurelienNicosiaULaval/tutorizeR/actions/runs/26715782406
Direct
R CMD build .in the live Git checkout was attempted but interrupted because R spent too long copying.gitbefore package exclusions were applied. Clean source-copy build/check succeeded.Review focus
Please review for JOSE readiness, truthfulness of educational claims, package quality, tests and CI, paper quality, vignettes, examples, licensing, and remaining blockers before a real JOSE submission.
Remaining limitations