Document fct_lump() in its own help topic and clarify superseded status #388
+154
−143
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.
This PR gives
fct_lump()its own help topic and clarifies that it issuperseded in favour of the more explicit helpers.
Changes:
fct_lump()describing it as asuperseded helper that delegates to
fct_lump_min(),fct_lump_prop(),fct_lump_n(), andfct_lump_lowfreq().their behaviour clearer.
devtools::document()currently reports some roxygen cross-referencewarnings for links between the helpers and for the
%in%operator; I amhappy to adjust these based on your preferred linking style.
Fixes #355.