Prepare for the initial CRAN submission - #108
Open
joethorley wants to merge 1 commit into
Open
joethorley wants to merge 1 commit into
joethorley wants to merge 1 commit into
Conversation
Version: set to the release version 0.1.0. The v0.1.0 tag is force-moved
to the release commit at submission time.
NEWS.md: fold the development sections into the release entry. "Format
with air" is internal noise and "Uncategorized" is a fledge placeholder
that had already leaked as far as inst/WORDLIST; neither belongs in the
first entry a CRAN user reads. Nothing preceded this release, so the
entry describes the package rather than listing changes.
DESCRIPTION: Depends was understated at R (>= 4.0). chk, dplyr and tidyr
all require R (>= 4.1), so the package cannot install on R 4.0. Also add
a sentence saying what the generated data frame is for, which is the
most common thing CRAN asks a new submission to expand on.
R/new-data.R: the deprecation cross-references were backtick-wrapped and
rendered as literal \verb{[xnew_value()]} rather than links.
R/xobs-only.R: give xobs_only() a description instead of repeating its
title.
cran-comments.md: list the test environments actually checked, state up
front that there are no method references, and flag that the CRAN status
badge does not resolve until publication.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Follow-up to #107. Addresses the manual-review items from a CRAN readiness review; the automated
R CMD checkgate was already clean.R CMD check --as-cranwith_R_CHECK_CRAN_INCOMING_REMOTE_now returns 0 errors, 0 warnings, 1 note ("New submission"). The "Version contains large components" note is gone.Version
Set to
0.1.0.v0.1.0is already tagged but was never accepted by CRAN, so the tag is force-moved to the release commit at submission time rather than burning a new version number.Note this interacts with
fledge-bump: the daily job will want to bump0.1.0back to a dev version. Worth either merging close to submission or skipping the schedule for a day.NEWS.md
Folded the development sections into the release entry. What CRAN and users would otherwise have read first:
Uncategorizedis a fledge placeholder that had already leaked far enough to become a word ininst/WORDLIST(also removed). Nothing preceded this release, so the entry describes the package rather than listing changes, consistent with 31e97d5.DESCRIPTION
Depends: R (>= 4.0)was not true.chk,dplyrandtidyrall require R >= 4.1, so the package cannot install on R 4.0. NowR (>= 4.1), and the backport comment inR/utils.Rsays 4.1/4.2 rather than "<= 4.2".Descriptiongained a sentence on what the generated data frame is actually for. Expanding the description is the most common round-trip CRAN asks of a new submission. Also removed a stray double space.Documentation
new_data()'s deprecation cross-references were backtick-wrapped, so they rendered as literal\verb{[xnew_value()]}instead of links (issuenew_data()has unclear and poorly formatted doc #98). Three of them.xobs_only()had no@description, so roxygen repeated its title.cran-comments.md
Was three lines. Now lists the environments actually checked (including the R-devel and no-suggests jobs added in #107), states up front that there are no published references describing the methods, and flags that the CRAN status badge URL does not resolve until publication.
Does not touch #102.
🤖 Generated with Claude Code