Repository navigation
Add package scaffolding and CI - #8
Merged
Merged
Conversation
Sets up an empty but checkable package so that the CI pipeline itself is validated before any code depends on it. Contents: `DESCRIPTION`, `NAMESPACE`, licence, `NEWS.md`, the five hubverse workflows with SHA-pinned actions, `.lintr`, `air.toml`, `codecov.yml`, `_pkgdown.yml` and the `.github` community files, all adapted from `hubEvals`. What this proves: the check matrix runs on all five platforms, `lintr` and `air format --check` gate as intended, and the pkgdown Netlify preview builds. Heavier dependency resolution (`arrow`, `hubUtils`, `hubExamples` from r-universe) first gets exercised in the following PRs, as each adds only the `Imports` it actually uses. Two deliberate deviations from the hubEvals template it is adapted from: the licence is GPL-3 rather than MIT, because this package is a derivative work of `aaronger/alloscore`; and docs publish to GitHub Pages via the standard r-lib `pkgdown.yaml`, matching reichlab/distfromq, rather than through hubEvals' Netlify PR-preview workflow, which reichlab does not use. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
nickreich
force-pushed
the
nr/scaffolding/1
branch
from
September 2, 2026 20:55
1d23de0 to
0d21a77
Compare
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.
Sets up an empty but checkable package, so the CI pipeline is validated before
any code depends on it.
This is the first of a stack of six PRs porting
alloscore to a hubverse-native
alloscore2. Each layer is self-contained and passesR CMD checkon its own;Importsgrows only as code actually uses each package, so there are no"declared but unused" NOTEs along the way.
Contents
DESCRIPTION,NAMESPACE,NEWS.md,LICENSE.md, five GitHub Actionsworkflows with SHA-pinned actions,
.lintr,air.toml,codecov.yml,_pkgdown.yml,.Rbuildignoreand the.githubcommunity files, all adaptedfrom
hubEvals. The only R file is the package doc.What this is meant to prove
lintr::lint_package()andair format . --checkgate as intendedhubStyleinstalls viaConfig/Needs/websiteHeavier dependency resolution (
arrow,hubUtils,hubExamplesfromr-universe) is first exercised in PRs 2 and 3.
Three deliberate deviations from the hubEvals template
GPL (>= 3), not MIT.alloscore2is a derivative work ofaaronger/alloscore, which is GPL-3, so the licence cannot be changed withoutthe original author's consent. Aaron Gerding is recorded in
DESCRIPTIONasaut, cph.use Netlify, so the inherited
pkgdown-netlify-preview.yamlis replaced withthe standard r-lib
pkgdown.yaml, matchingreichlab/distfromq. It stillbuilds the site on every PR and deploys to
gh-pageson push tomain.Actions stay SHA-pinned, which distfromq's copy does not do.
.lintrrelaxes two linters. The allocation literature's notation is partof this package's public API —
Fis a predictive cdf,Qa quantilefunction,
Ka budget,OandUover- and under-prediction costs,Lambdaa marginal expected benefit — and
eps_Kandqs_OKare documented argumentand column names inherited from the original package.
object_name_linterandT_and_F_symbol_linterflag all of those, so both are relaxed rather thanrenaming public API.
indentation_linteris disabled because it disagreeswith Air, which owns formatting here. The reasoning is in a comment at the top
of the file.
Verified locally
R CMD check: Status: OK.lintr::lint_package(): 0 lints.air format . --check: clean.