Repository navigation
Spell the project name RainDrop consistently; record the Zenodo DOI - #22
Merged
Merged
Conversation
- 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
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
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
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.
Reopened after merging the current
devinto the branch — the merge conflict that made this PR un-mergeable is resolved.Spelling
RAINDROP→RainDropacrossDESCRIPTION(funder),_pkgdown.yml, roxygen docs and the corresponding man pages, the vignettes,CITATION.cffand.zenodo.json.Three things deliberately keep their spelling, because they are technical identifiers rather than the project name:
Mulde_Rigole_RAINDROP*.txt,Optimierung_MuldenRigole_RAINDROP*.txt) written by the Tandler engine,inst/extdata/models/*/base.h5),*_Raindrop_Datendata directories in the local-path examples.Citation — the concept DOI
CITATION.cffandinst/CITATIONnow carry the concept DOI10.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/CITATIONtakes the package version frommeta$Versioninstead of a hard-coded0.1.0..zenodo.jsondeliberately 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—devreplaced the cross-reference to the removedmonotonicity_analysisvignette with the external link onraindrop.kompetenz-wasser.io. Resolved in favour ofdev's link, with the spelling fix applied to it.vignettes/monotonicity_analysis.Rmd—devdeleted it as a deploy-only article (together withvignettes/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 readRAINDROP, so it no longer matchedperson("RainDrop", role = "fnd")inDESCRIPTION; 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.Rand 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 (
devbumped to roxygen2 8.1.0 after this branch was cut):man/download_engine.Rdandman/run_model.Rd(\link[]anchors resolved against a different R/fs/tools installation) andman/plot_valid_design_space.Rd(indentation only). They now matchdevagain, 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 threewindows-latest(release/devel/oldrel)R CMD checkjobs on this PR exerciseinst/CITATION(includingmeta$Version) and the.Rdcross-references. Checked locally in addition:CITATION.cffvalidates against the official CFF 1.2.0 JSON schema (jsonschema, schema fetched from the citation-file-format repo),.zenodo.jsonparses as JSON,_pkgdown.ymlparses as YAML,R/diff touches roxygen comment lines only, and the pkgdown author key now matches theDESCRIPTIONfunder 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.