Skip to content

README: plain description, real airphotos, ecosystem table; changelog and reference index (#104) - #105

Merged
NewGraphEnvironment merged 13 commits into
mainfrom
104-readme-describe-terrain-aware-footprints
Oct 17, 2026
Merged

NewGraphEnvironment merged 13 commits into
mainfrom
104-readme-describe-terrain-aware-footprints

Conversation

@NewGraphEnvironment

Copy link
Copy Markdown
Owner

Summary

  • README in plain words, with real airphotos. It opens with what fly does and what a historic photo gives a site: a reference for what to restore toward, and a baseline for measuring change. It notes that an elevation model makes film footprints more accurate and corrects the flying-height errors fly can identify. The figure shows the upper Bulkley River near McKilligan Road in 1971 and 1981, from two photos fly georeferenced (data-raw/readme_figure.R). The function list, "Used by" and "Related packages" are replaced by the shared ecosystem table, in soul's README section order.
  • DESCRIPTION, GitHub About and tagline agree. Description follows the opening and no longer says fly downloads scans (it downloads thumbnails). The GitHub About now equals Title.
  • Changelog: one section per release. All 37 releases sat under a leftover # fly (development version), so the website showed a single section. Each is now # fly x.y.z (date).
  • Reference index grouped by purpose: estimate footprints, choose photos for an area, download, georeference.
  • Release v0.24.1. No R code changed.

Related Issues

Test plan

  • devtools::test(): 5765 pass, 0 fail
  • pkgdown::check_pkgdown() clean. Built locally: the changelog has 37 sections (was 1), the reference index has 4 groups, and the home page renders with the figure
  • README example re-run on the bundled data reproduces the pasted output; all 23 README links return 200; every function named is exported
  • /code-check branch: rounds 1-3. Round 3 enumerated all 54 published sentences against the code; every one not true was fixed

Notes

The review found one recurring defect in the text: a sentence written from the typical case (a film frame, the bundled photos, what the selection aims for) and stated of every photo. Round 1's fix turned "each" into a plural, which kept the claim, so the loop was closed by enumeration rather than by a quiet round. Details are in planning/archive/2026-10-issue-104-readme-reference-condition/.

Outside this diff, fly_select()'s roxygen still says it "picks the fewest photos" (it names greedy set-cover alongside). flooded's and breaks' ecosystem rows for fly still say "select optimal coverage", where this README now says "select photos that cover a study area".

🤖 Generated with Claude Code

https://claude.ai/code/session_015vTioCEKJYFcmqg1oh3Fdg

NewGraphEnvironment and others added 13 commits October 16, 2026 23:40
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015vTioCEKJYFcmqg1oh3Fdg
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015vTioCEKJYFcmqg1oh3Fdg
data-raw/readme_figure.R crops the 1971 and 1981 stac-airphoto-bc
thumbnails at McKilligan Rd, upper Bulkley, to one 2 km box.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015vTioCEKJYFcmqg1oh3Fdg
Section order per the README convention. The opening says what fly does
and the reference condition it informs, and ties the terrain sizing and
the flying-height repairs to an elevation model, where they run. The
figure is two georeferenced airphotos of one site in 1971 and 1981.
DESCRIPTION's Description follows the opening.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015vTioCEKJYFcmqg1oh3Fdg
Every release sat under a leftover '# fly (development version)', so the
published changelog showed a single section. Each '## x.y.z (date)' is
now '# fly x.y.z (date)'.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015vTioCEKJYFcmqg1oh3Fdg
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015vTioCEKJYFcmqg1oh3Fdg
Code-check round 1: the DEM route excludes frames sized from GSD and the
height check runs on film only, so neither is stated of each photo. The
pkgdown Georeference group says the same.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015vTioCEKJYFcmqg1oh3Fdg
…ery photo (#104)

Code-check round 2: the round 1 fixes turned 'each' into plurals that made
the same claim. Terrain sizing is stated of film photos, selection as a
small set (it is greedy), and georeferencing as something fly can do.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015vTioCEKJYFcmqg1oh3Fdg
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015vTioCEKJYFcmqg1oh3Fdg
…#104)

Code-check round 3 enumerated every published sentence. fly_fetch()
downloads thumbnails, so 'scans' is kept only where fly_georef() takes
them; the figure's box is 625 m from McKilligan Road; footprints come for
most photos; and the height repairs are stated as the errors fly can
identify.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015vTioCEKJYFcmqg1oh3Fdg
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015vTioCEKJYFcmqg1oh3Fdg
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015vTioCEKJYFcmqg1oh3Fdg
@NewGraphEnvironment
NewGraphEnvironment merged commit e1ab42d into main Oct 17, 2026
4 checks passed
@NewGraphEnvironment
NewGraphEnvironment deleted the 104-readme-describe-terrain-aware-footprints branch October 17, 2026 07:31
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.

README: describe terrain-aware footprints and per-roll calibration

1 participant