Skip to content

Spell the project name RainDrop consistently; record the Zenodo DOI - #22

Merged
mrustl merged 4 commits into
devfrom
claude/simultane-parameteroptimierung-3fg5o9
Sep 25, 2026
Merged

mrustl merged 4 commits into
devfrom
claude/simultane-parameteroptimierung-3fg5o9

Conversation

@mrustl

@mrustl mrustl commented Aug 24, 2026 •

Copy link
Copy Markdown
Member

Reopened after merging the current dev into the branch — the merge conflict that made this PR un-mergeable is resolved.

Spelling

RAINDROP → RainDrop across DESCRIPTION (funder), _pkgdown.yml, roxygen docs and the corresponding man pages, the vignettes, CITATION.cff and .zenodo.json.

Three things deliberately keep their spelling, because they are technical identifiers rather than the project name:

  • the engine's fixed output file names (Mulde_Rigole_RAINDROP*.txt, Optimierung_MuldenRigole_RAINDROP*.txt) written by the Tandler engine,
  • the strings inside the HDF5 model fixtures (inst/extdata/models/*/base.h5),
  • the *_Raindrop_Daten data directories in the local-path examples.

Citation — the concept DOI

CITATION.cff and inst/CITATION now carry the concept DOI 10.5281/zenodo.21839222, which always resolves to the newest release. The placeholder footer pointing to a future DOI is gone.

A version DOI cannot live in the repository: Zenodo mints it only after a release has been archived, so at the moment these files are written — before tagging — the DOI of the release being tagged does not exist yet. Recording the previous release's version DOI instead would make every archived snapshot point at its predecessor. The concept DOI has neither problem: it is fixed from the first release on. Both files carry a comment saying so, so it does not get "corrected" to a version DOI later.

Version DOIs stay available where they are always accurate: the version list on the Zenodo record the concept DOI resolves to.

Two related bits of release-time staleness removed at the same time:

  • inst/CITATION takes the package version from meta$Version instead of a hard-coded 0.1.0.
  • .zenodo.json deliberately carries no DOI: it describes the upload for which Zenodo mints the next DOI itself.

Conflict resolution against dev

  • R/find_min_feasible.R / man/find_min_feasible.Rd — dev replaced the cross-reference to the removed monotonicity_analysis vignette with the external link on raindrop.kompetenz-wasser.io. Resolved in favour of dev's link, with the spelling fix applied to it.
  • vignettes/monotonicity_analysis.Rmd — dev deleted it as a deploy-only article (together with vignettes/index.Rmd). The deletion wins over this branch's spelling-only edit.

Carried through to what dev added in the meantime

  • _pkgdown.yml — the funder entry that came in with the project logo read RAINDROP, so it no longer matched person("RainDrop", role = "fnd") in DESCRIPTION; pkgdown matches these by name, so the logo would not have been attached to the author. Alt text spelled out as well.
  • R/get_simulation_results_all.R, _optim.R, _optim_parallel.R and their man pages — the roxygen titles read "Read Raindrop optimisation simulation results …".

Dropped from the branch

Three man pages that carried only roxygen regeneration noise, no spelling change (dev bumped to roxygen2 8.1.0 after this branch was cut): man/download_engine.Rd and man/run_model.Rd (\link[] anchors resolved against a different R/fs/tools installation) and man/plot_valid_design_space.Rd (indentation only). They now match dev again, so the diff is spelling and citation metadata only.

Verification

R is not available in the environment this was prepared in, so no local R CMD check / devtools::document() run — but the three windows-latest (release/devel/oldrel) R CMD check jobs on this PR exercise inst/CITATION (including meta$Version) and the .Rd cross-references. Checked locally in addition:

  • CITATION.cff validates against the official CFF 1.2.0 JSON schema (jsonschema, schema fetched from the citation-file-format repo),
  • .zenodo.json parses as JSON, _pkgdown.yml parses as YAML,
  • no conflict markers remain, the R/ diff touches roxygen comment lines only, and the pkgdown author key now matches the DESCRIPTION funder name.

What CI does not verify is whether the man pages are bit-identical to what devtools::document() would produce — worth one run on your side before merging.

- RAINDROP -> RainDrop across DESCRIPTION (funder), NEWS, roxygen docs,
  regenerated man pages, vignettes, CITATION.cff and .zenodo.json. The
  engine's fixed output file names (Mulde_Rigole_RAINDROP*.txt,
  Optimierung_MuldenRigole_RAINDROP*.txt) are technical identifiers
  written by the Tandler engine and deliberately keep their spelling.
- CITATION.cff and inst/CITATION now carry the version DOI of the
  released v0.1.0 archive (10.5281/zenodo.21839223); the placeholder
  footer pointing to a future DOI is gone.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017npvdq8XW1Lg1t2dNX9sGH
@mrustl mrustl closed this Aug 24, 2026
Resolves the conflicts that blocked the "RainDrop" spelling PR against
the current dev:

- R/find_min_feasible.R, man/find_min_feasible.Rd: dev replaced the
  cross-reference to the removed `monotonicity_analysis` vignette with
  the external link on raindrop.kompetenz-wasser.io. Keep dev's link and
  apply the spelling fix to it (RAINDROP -> RainDrop).
- vignettes/monotonicity_analysis.Rmd: dev deleted it as a deploy-only
  article (like vignettes/index.Rmd); the deletion wins over this
  branch's spelling-only edit.

Carried the spelling through to what dev added in the meantime:

- _pkgdown.yml: the funder entry added with the project logo read
  RAINDROP, so it no longer matched `person("RainDrop", role = "fnd")`
  in DESCRIPTION and pkgdown could not attach the logo to the author.
  Alt text spelled out as well.
- The "Read Raindrop optimisation simulation results ..." roxygen titles
  of get_simulation_results_all/_optim/_optim_parallel() and their man
  pages.

Dropped three man pages from the branch that only carried roxygen
regeneration noise, not spelling (dev bumped to roxygen2 8.1.0 after
this branch was cut): man/download_engine.Rd, man/run_model.Rd
(\link[] anchors resolved against a different R/fs/tools installation)
and man/plot_valid_design_space.Rd (indentation only).

Engine-written file names (Mulde_Rigole_RAINDROP*.txt,
Optimierung_MuldenRigole_RAINDROP*.txt), the HDF5 model fixtures and the
"*_Raindrop_Daten" data directories keep their spelling: they are
technical identifiers, not the project name.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012P8tqzLoudLCjx18ASDatE
@mrustl mrustl reopened this Sep 22, 2026
The version DOI (10.5281/zenodo.21839223) pins the archived v0.1.0 and
stays where it is: it sits next to `version: 0.1.0` / `date-released:`
in CITATION.cff and next to `note = "R package version 0.1.0"` in
inst/CITATION, so a citation built from either file resolves to exactly
the release it names.

What was missing is the concept DOI (10.5281/zenodo.21839222), which
Zenodo always resolves to the newest release:

- CITATION.cff gains an `identifiers` block listing both DOIs with a
  description each. CFF 1.2.0 treats the top-level `doi` as shorthand
  "most useful when there is just one DOI"; with two, `identifiers` is
  the place that can say which is which. Validated against the official
  CFF 1.2.0 JSON schema.
- inst/CITATION gains a footer naming the concept DOI for citing the
  package in general.

.zenodo.json deliberately stays without a DOI: it describes the upload
for which Zenodo mints the next DOI itself.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012P8tqzLoudLCjx18ASDatE
The version DOI cannot be recorded in the repository: Zenodo mints it
only after a release has been archived, so at the moment CITATION.cff
and inst/CITATION are written - before tagging - the DOI of the release
being tagged does not exist yet. Writing the previous release's version
DOI would make every archived snapshot point at its predecessor.

The concept DOI (10.5281/zenodo.21839222) has neither problem: it is
fixed from the first release on and always resolves to the newest one.
It is now the DOI in both files, with a comment in each saying why, so
it does not get "corrected" to a version DOI later. Version DOIs stay
available where they are always accurate: the version list on the Zenodo
record the concept DOI resolves to.

Also drops the hard-coded package version from inst/CITATION in favour
of `meta$Version`, so that field cannot go stale at release time either.

CITATION.cff re-validated against the official CFF 1.2.0 JSON schema.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012P8tqzLoudLCjx18ASDatE
@mrustl
mrustl merged commit 0fff445 into dev Sep 25, 2026
5 checks passed
@mrustl
mrustl deleted the claude/simultane-parameteroptimierung-3fg5o9 branch September 25, 2026 06:11
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.

2 participants