Docs: columnsForPixelGroups() is a function, and its default includes B - #112
Open
eliotmcintire wants to merge 1 commit into
Open
Docs: columnsForPixelGroups() is a function, and its default includes B#112eliotmcintire wants to merge 1 commit into
eliotmcintire wants to merge 1 commit into
Conversation
Two corrections to one metadata string:
- add parens, since LandR made columnsForPixelGroups a function; the
bare form in the docs now points at the function object.
- the stated default omitted "B". LandR::columnsForPixelGroups()
returns c("ecoregionGroup", "speciesCode", "age", "B").
Documentation only; no code path changes.
This was referenced Sep 12, 2026
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.
Documentation only — one metadata string, no code path changes.
expectsInput("columnsForPixelGroups", "character", paste("The names of the columns in `cohortData` that define unique `pixelGroup`s.", - "Default is `c('ecoregionGroup', 'speciesCode', 'age')`;", - "see `?LandR::columnsForPixelGroups`).")), + "Default is `c('ecoregionGroup', 'speciesCode', 'age', 'B')`;", + "see `?LandR::columnsForPixelGroups()`).")),Two corrections
1. Parens. LandR changed
columnsForPixelGroupsfrom a character vector to a function (R/cohorts.R:1741). The bare form in this docstring now points a reader at the function object rather than the thing they want. The module's own code at line 1731 already calls it correctly with parens — this just brings the prose in line.2. The stated default was wrong, independent of the above. It claimed
c('ecoregionGroup', 'speciesCode', 'age'), but LandR returns four columns:"B"was missing. I noticed this while fixing the parens and corrected it in the same string rather than leave a known-false default sitting next to a line I was already touching. Happy to split it out if you would rather keep the changes separate.Scope
Companion to PredictiveEcology/Biomass_core#108, which fixes the one genuine code site (
Biomass_core.R:870assigned the function object instead of calling it). I audited both modules across all branches plus the rest of the organisation; this docstring was the only remaining bare reference anywhere, and being prose it was harmless — hence docs-only here.File parses clean.