Repository navigation
Say that merge(collapse = TRUE) is not implemented - #309
Closed
BenjaminDEMAILLE wants to merge 1 commit into
Closed
BenjaminDEMAILLE wants to merge 1 commit into
BenjaminDEMAILLE wants to merge 1 commit into
Conversation
The documentation describes the argument as working:
collapse: If TRUE, merge layers of the same name together; if FALSE,
appends labels to the layer name
Passing it does this instead:
merge(a, b, collapse = TRUE)
#> Error: Collapsing layers is not yet supported
So a reader has no way to know the option is unavailable short of trying
it, which is how the report arrives at it.
Document the actual state in the roxygen block and the three generated Rd
files that carry it. merge.Assay.Rd already records `labels, collapse` as
"Currently unused" for the v3 method and is left alone.
No behaviour change: this describes the code as it is rather than
implementing the feature, which is a larger piece of work and a separate
decision. The added test pins the documented contract so the two cannot
drift apart again unnoticed.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This was referenced Aug 31, 2026
Author
|
Superseded by #319, which groups the message-only PRs into one, since they share a rationale and none of them changes behaviour. The commit is carried over unchanged; closing here to keep the queue down rather than because anything was wrong with it. |
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.
Fixes #175.
The problem
The documentation describes
collapseas a working option:Passing it does this:
A reader has no way to know the option is unavailable short of trying it, which is how the report arrives at it.
The change
Document the actual state, in the roxygen block and the three generated Rd files that carry it:
man/merge.Assay.Rdalready recordslabels, collapseas "Currently unused" for the v3 method, so it is left alone.No behaviour change. This describes the code as it is rather than implementing the feature, which is a larger piece of work and a separate decision. Happy to close this in favour of implementing
collapseif that is on the roadmap.Tests
New
tests/testthat/test_merge_collapse.Rpins the documented contract so the docs and the code cannot drift apart again unnoticed:collapse = TRUEraises,collapse = FALSEkeeps the layers separate and merges the cells, and the default matchescollapse = FALSE.Suite 180 passing,
R CMD checkStatus OK.🤖 Generated with Claude Code