Skip to content

docs: prepare JOSE review materials#5

Draft
AurelienNicosiaULaval wants to merge 10 commits into
release/v0.4.4from
review/jose-readiness
Draft

docs: prepare JOSE review materials#5
AurelienNicosiaULaval wants to merge 10 commits into
release/v0.4.4from
review/jose-readiness

Conversation

@AurelienNicosiaULaval
Copy link
Copy Markdown
Owner

@AurelienNicosiaULaval AurelienNicosiaULaval commented May 31, 2026

Summary

Prepare tutorizeR for a future JOSE review as open-source educational infrastructure, not merely as a JOSS/CRAN readiness pass.

Scope

  • Reframes README, paper, pkgdown, and reviewer docs around JOSE.
  • Rewrites paper/paper.md as a JOSE-oriented software paper with cautious educational claims.
  • Adds pedagogical references used in the paper.
  • Adds 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, and docs/jose_pr_final_report.md.
  • Rebuilds inst/examples/example_course_module/ as an installable teaching example with source lesson, question bank, expected outputs, report, and run-example.R.
  • Adds vignettes/teaching-workflow-case-study.Rmd and expands core vignettes for JOSE review.
  • Adds LICENSE-CONTENT.md for CC-BY 4.0 educational content and figure licensing.
  • Adds example tests and strengthens coverage CI logic.

Validation

Validated locally on 2026-05-31:

  • Read official JOSE submitting, review criteria, and review checklist pages.
  • Rscript -e "testthat::test_local('.')": PASS, 144 tests.
  • Rscript -e "lintr::lint_package()": PASS, no lints.
  • _pkgdown.yml parsed with yaml::read_yaml(): PASS.
  • paper/paper.md rendered with bibliography resolution: PASS.
  • 13 vignettes rendered to a temporary output directory: PASS.
  • run-example.R works after local package load: PASS.
  • Coverage script: PASS, total 71.58%, core 93.36%.
  • Clean source-copy R CMD build: PASS.
  • Clean source-copy R CMD check --as-cran --no-manual: PASS with 1 NOTE for new submission.

GitHub Actions on the latest PR head passed:

  • coverage: PASS, 1m22s.
  • lintr: PASS, 1m8s.
  • testthat: PASS, 1m15s.
  • R CMD check Ubuntu: PASS, 1m57s.
  • R CMD check macOS: PASS, 3m21s.
  • R CMD check Windows: PASS, 3m29s.

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 .git before 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

  • Formal learning-outcome evaluation: Not verifiable from repository contents.
  • Actual classroom deployment: Not verifiable from repository contents.
  • Broad external adoption: Not verifiable from repository contents.
  • Final release DOI and ORCID metadata still need maintainer confirmation.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant