Skip to content

pkgdown site and a developer vignette (writing a fetch function) - #17

Merged
mdsumner merged 1 commit into
mainfrom
pkgdown-devguide
Oct 3, 2026
Merged

mdsumner merged 1 commit into
mainfrom
pkgdown-devguide

Conversation

@mdsumner

@mdsumner mdsumner commented Oct 3, 2026

Copy link
Copy Markdown
Member

Closes #16

Developer vignette: vignette("fetch", package = "altarr"), "Writing a fetch function". It is aimed at people who maintain Zarr, netCDF, GDAL or object-store readers. Everything runs offline in a couple of seconds, apart from the sketches that need other packages.

  • the smallest fetch (an in-memory array, chunk_of()), which doubles as the reference for testing
  • check_fetch(): compares a backend with its reference across every path base R takes
  • altarr's own error messages for padded edge chunks, wrong list length, wrong types, and fetch errors
  • a logged fetch that shows how each base R operation arrives: x[i] 1 call, x[cbind()] 1 call, x[i,j,k] 1 chunk per call, altarr_extract() 1 call, sum() in 64-chunk batches, mean() one 24-chunk layer per call; and why reading the rows of one call concurrently is the big win
  • dimension order (reverse, never transpose), types, decoding, int64
  • recipes: factories, force(), and re-opening external-pointer handles lazily
  • pinned sources
  • sketches (not evaluated) for ncdf4 and gdalraster, and notes on chunk byte references
  • development tools: altarr_stats(), altarr_plan(), and the options as stress tests

pkgdown: _pkgdown.yml (grouped reference, an articles menu linking the hypertidy post) and .github/workflows/pkgdown.yaml (the standard r-lib workflow, deploying docs/ to gh-pages on pushes to main). After the first deploy, turn on Pages in the repo settings: Pages, deploy from branch gh-pages, folder / (root).

Also: README links the site, both vignettes and the contract; NEWS entry; version 0.1.0.9000; vignette titles now match their index entries (rmarkdown warned).

Locally, R CMD check --as-cran gives the same result as #15: only the container's notes. pkgdown reference and articles build cleanly. The news page and home page can't build here only because they query CRAN, which is unreachable from this machine.

🤖 Generated with Claude Code

https://claude.ai/code/session_01TowCbPXVpB8oRsDNNywRUz


Generated by Claude Code

- vignettes/fetch.Rmd: the contract worked through with runnable code,
  a reference test harness, how each base R operation arrives at fetch,
  dimension order, decoding, recipes and handles, pinned sources, and
  sketches for ncdf4 and gdalraster
- _pkgdown.yml and a GitHub Actions workflow deploying to gh-pages
- README links the site, both vignettes and the contract
- vignette titles match their index entries

Closes #16

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TowCbPXVpB8oRsDNNywRUz
@mdsumner
mdsumner merged commit 8b962d5 into main Oct 3, 2026
6 checks passed
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.

pkgdown site and a developer vignette (writing a fetch function)

2 participants