docs: add grouped rolling mean example to runner.Rd#111
Merged
Conversation
Add a panel data example to the runner.grouped_df method showing how to compute rolling means within groups using dplyr. This is the most common Stata migration pattern (bysort + rolling).
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.
Summary
Added a panel data example to the
runner.grouped_dfmethod inrunner.Rdshowing how to compute rolling means within groups using dplyr.Stata equivalent:
runner equivalent (new example):
Rationale
The
runner.grouped_dfmethod had no examples. Rolling operations within groups (panel data) is the single most common migration scenario from Stata, wherebysort+rollingautomatically handles group boundaries. Therunner()function with dplyr'sgroup_byprovides the equivalent functionality.Validation
tools::checkRd('man/runner.Rd')passes (no output = no errors)