-
-
Notifications
You must be signed in to change notification settings - Fork 18.6k
DOC: Add example of NonFixedVariableWindowIndexer usage #34994
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
jreback
merged 7 commits into
pandas-dev:master
from
mroeschke:nonfixedvariablewindowindexer_example
Jun 29, 2020
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
0fbb6c3
DOC: Add example of NonFixedVariableWindowIndexer usage
1f30efc
Merge remote-tracking branch 'upstream/master' into nonfixedvariablew…
170da45
move version added
95eaec5
use ipython block
ef8994a
Merge remote-tracking branch 'upstream/master' into nonfixedvariablew…
e31b236
Merge remote-tracking branch 'upstream/master' into nonfixedvariablew…
c0f9368
Add NonFixedVariableWindowIndexer to api.indexers
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -597,6 +597,18 @@ You can view other examples of ``BaseIndexer`` subclasses `here <https://github. | |
|
||
.. versionadded:: 1.1 | ||
|
||
One subclass of note within those examples is the ``NonFixedVariableWindowIndexer`` that allows | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we should rename this Indexer, its a bit redundant (NonFixedVariable)......followon ok |
||
rolling operations over a non-fixed offset like a ``BusinessDay``. | ||
|
||
.. ipython:: python | ||
|
||
from pandas.api.indexers import NonFixedVariableWindowIndexer | ||
df = pd.DataFrame(range(10), index=pd.date_range('2020', periods=10)) | ||
offset = pd.offsets.BDay(1) | ||
indexer = NonFixedVariableWindowIndexer(index=df.index, offset=offset) | ||
df | ||
df.rolling(indexer).sum() | ||
|
||
For some problems knowledge of the future is available for analysis. For example, this occurs when | ||
each data point is a full time series read from an experiment, and the task is to extract underlying | ||
conditions. In these cases it can be useful to perform forward-looking rolling window computations. | ||
|
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,15 @@ | |
""" | ||
|
||
from pandas.core.indexers import check_array_indexer | ||
from pandas.core.window.indexers import BaseIndexer, FixedForwardWindowIndexer | ||
from pandas.core.window.indexers import ( | ||
BaseIndexer, | ||
FixedForwardWindowIndexer, | ||
NonFixedVariableWindowIndexer, | ||
) | ||
|
||
__all__ = ["check_array_indexer", "BaseIndexer", "FixedForwardWindowIndexer"] | ||
__all__ = [ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can you add a test for this in test_api (followon ok) |
||
"check_array_indexer", | ||
"BaseIndexer", | ||
"FixedForwardWindowIndexer", | ||
"NonFixedVariableWindowIndexer", | ||
] |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
show df here