Skip to content

Describe the parallel downloading, and declare the R version - #13

Merged
chross22 merged 2 commits into
masterfrom
describe-parallel-and-declare-r-version
Aug 6, 2026
Merged

Describe the parallel downloading, and declare the R version#13
chross22 merged 2 commits into
masterfrom
describe-parallel-and-declare-r-version

Conversation

@chross22

@chross22 chross22 commented Aug 6, 2026

Copy link
Copy Markdown
Owner

Two unrelated tidy-ups after #12, kept as separate commits.

Declare the R version

R CMD build inferred a dependency on R >= 4.1.0 on every build and warned about it, because the package uses the |> pipe introduced there without saying so in DESCRIPTION.

4.1.0 is the floor the syntax actually implies: the pipe and the \(x) function shorthand both arrive in that release, and the package uses the former in two files (R/accessEnvDat.R, R/matchData.R) and the latter nowhere. %||% is defined in R/variables.R rather than taken from base, which is what keeps the floor below the 4.4.0 that base's version would require.

Verified: the build warning is gone, and packageDescription("datamatch")$Depends reports R (>= 4.1.0).

Make the parallel downloading findable

The section existed but did not answer the question a reader arrives with — whether there is an option, and what it is called. Three things were in the way:

  • Neither this section nor the daily one was in the table of contents, so a reader scanning the contents concluded there was nothing to find.
  • The section never named n_workers or its default of 4. It described the behaviour ("downloads go out four at a time") without saying which argument controls it or that it is on without being asked for.
  • Both examples passed frequency = "daily", which reads as parallelism being a daily-only feature. It is not: any fetch spanning more than one time step is more than one download, and a fifteen-year monthly record is 180 of them. The examples are monthly now, and say so.

Also adds what it deliberately does not do, since both are easy to assume the other way: cached files are read from disk rather than re-fetched, and each accessEnvDat() call is one dataset, so SST and CHL remain two calls run one after the other.

No runtime behaviour changes — DESCRIPTION metadata and README prose only. All 25 table-of-contents anchors were checked against the rendered headings and resolve.

🤖 Generated with Claude Code

chross22 and others added 2 commits August 6, 2026 17:56
R CMD build inferred a dependency on R >= 4.1.0 on every build and
warned about it, because the package uses the |> pipe introduced there
(R/accessEnvDat.R and R/matchData.R) without saying so in DESCRIPTION.

4.1.0 is the floor the syntax actually implies: the pipe and the \(x)
function shorthand both arrive in that release, and the package uses the
former in two files and the latter nowhere. %||% is defined in
R/variables.R rather than taken from base, which is what keeps the floor
below the 4.4.0 that base's version would require.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The section existed but did not answer the question a reader arrives
with, which is whether there is an option and what it is called. Three
things were in the way.

Neither this section nor the daily one was in the table of contents, so
a reader scanning the contents for it concluded there was nothing to
find.

The section described the behaviour - downloads "go out four at a time" -
without naming n_workers or saying it defaults to 4. Someone looking for
the argument had to read the whole paragraph to learn it exists.

Both examples passed frequency = "daily", which reads as parallelism
being a daily-only feature. It is not: any fetch spanning more than one
time step is more than one download, and a fifteen-year monthly record
is 180 of them. The examples are monthly now, and say so.

Adds what it deliberately does not do, since both are easy to assume the
other way: cached files are read from disk rather than re-fetched, and
each accessEnvDat() call is one dataset, so SST and CHL remain two calls
run one after the other.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@chross22
chross22 merged commit f60354c into master Aug 6, 2026
@chross22
chross22 deleted the describe-parallel-and-declare-r-version branch August 6, 2026 22:52
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