DOC: Added reverse rolling window examples #39091

vangorade · 2021-01-10T15:29:50Z

closes DOC: example for doing a reversed rolling window #38627
tests added / passed
Ensure all linting tests pass, see here for how to run them
whatsnew entry

mroeschke · 2021-01-11T07:35:44Z

doc/source/user_guide/window.rst

@@ -198,6 +198,36 @@ from present information back to past information. This allows the rolling windo

   df

+.. _window.reverse_rolling_window:
+
+Reverse rolling window


Can you just add this as an example of using the FixedForwardWindowIndexer in the Custom window rolling section below?

Sorry for late reply. Sure i will add it.

MarcoGorelli · 2021-01-12T14:14:41Z

doc/source/user_guide/window.rst

+   # Using slicing
+   # apply the rolling aggregation and then flip the result.


looking at other examples from this document, descriptions are typically outside the code blocks (rather than inside them as comments)

Agreed. Would be better if this description was a paragraph before the example.

MarcoGorelli · 2021-01-12T14:14:59Z

doc/source/user_guide/window.rst

+   df = pd.DataFrame(data=[[pd.Timestamp('2018-01-01 00:00:00'), 100],
+                           [pd.Timestamp('2018-01-01 00:00:01'), 101],
+                           [pd.Timestamp('2018-01-01 00:00:03'), 103],
+                           [pd.Timestamp('2018-01-01 00:00:04'), 111]],
+                     columns=['time', 'value']).set_index('time')
+   df


can you apply the black formatter to this code block?

jreback · 2021-01-13T13:28:31Z

doc/source/user_guide/window.rst

-   df.rolling(2, method="table", min_periods=0).apply(weighted_mean, raw=True, engine="numba")  # noqa:E501
+   df.rolling(2, method="table", min_periods=0).apply(
+       weighted_mean, raw=True, engine="numba"
+   )  # noqa:E501


this noqa is no longer needed

jreback · 2021-01-13T13:28:49Z

doc/source/user_guide/window.rst

@@ -132,13 +135,13 @@ time based index must be monotonic.

 .. ipython:: python

-   times = ['2020-01-01', '2020-01-03', '2020-01-04', '2020-01-05', '2020-01-29']
+   times = ["2020-01-01", "2020-01-03", "2020-01-04", "2020-01-05", "2020-01-29"]


prefer that you don't change the quoting as its non-essential to this change

jreback · 2021-01-13T13:29:18Z

doc/source/user_guide/window.rst

+   ).set_index("time")
+   df
+
+   df1 = df[::-1].rolling("2s").sum()[::-1]


call this reversed_df or similar

jreback · 2021-01-13T13:29:50Z

doc/source/user_guide/window.rst

+   df1 = df[::-1].rolling("2s").sum()[::-1]
+   df1
+
+Or we can also do it using FixedForwardWindowIndexer which basically Creates window boundaries


can you add the refernce to this, something like :meth:`api.indexers.FixedForwardWindowIndexer`

jreback · 2021-01-13T13:30:02Z

doc/source/user_guide/window.rst

+
+.. ipython:: python
+
+   df = pd.DataFrame(


no need to repeat this

jreback · 2021-01-13T13:30:14Z

doc/source/user_guide/window.rst

+
+   indexer = pd.api.indexers.FixedForwardWindowIndexer(window_size=2)
+
+   df2 = df.rolling(window=indexer, min_periods=1).sum()


name as above

jreback · 2021-01-13T13:30:54Z

doc/source/user_guide/window.rst

@@ -280,11 +330,23 @@ conditions. In these cases it can be useful to perform forward-looking rolling w
 This :func:`BaseIndexer <pandas.api.indexers.BaseIndexer>` subclass implements a closed fixed-width
 forward-looking rolling window, and we can use it as follows:

-.. ipython:: ipython
+.. ipython:: python


instead of having this here I woul dmove the example from above here. no reason to have this in 2 places and this is the best one.

jreback · 2021-01-21T19:23:30Z

can you merge master and update

jreback · 2021-02-11T00:34:14Z

@vangorade can you merge master and update

github-actions · 2021-03-14T00:14:23Z

This pull request is stale because it has been open for thirty days with no activity. Please update or respond to this comment if you're still interested in working on this.

mroeschke · 2021-03-14T03:57:55Z

Going to close this PR due to lack of activity. Let us know if you'd like to continue working on it.

@vangorade

File is copied from @vangorade last changes in pull request (pandas-dev#39091): pandas-dev#39091 Fixed typo to pass pre-commit codespell hook.

From pull request (pandas-dev#39091): pandas-dev#39091 - remove noqa - change line back to single quotes - rename df1 to reversed_df

From pull request (pandas-dev#39091): pandas-dev#39091 - remove repeated df initialization in code example - rename df2 to reversed_df

…andas-dev#38627). Move code example as suggested in pull request (pandas-dev#39091): pandas-dev#39091 Compiled document to check it looked fine by running: python make.py --single user_guide/window.rst

@vangorade

* DOC: Add examples to do reversed rolling window (#38627). File is copied from @vangorade last changes in pull request (#39091): #39091 Fixed typo to pass pre-commit codespell hook. * DOC: Add some suggested changes. From pull request (#39091): #39091 - remove noqa - change line back to single quotes - rename df1 to reversed_df * DOC: Add reference to FixedForwardWindowIndexer. * DOC: Add more suggested changes. From pull request (#39091): #39091 - remove repeated df initialization in code example - rename df2 to reversed_df * DOC: Add suggested changes to reverse rolling window code examples (#38627). Move code example as suggested in pull request (#39091): #39091 Compiled document to check it looked fine by running: python make.py --single user_guide/window.rst * DOC: Revert more double quotes to single quotes. Unecessary changes. * DOC: Change binary window description to match master branch. Description was not modified after fetching and merging, so pasted from master branch: https://github.com/pandas-dev/pandas/blob/master/doc/source/user_guide/window.rst * DOC: Change exponentially weighted mean formula to one in master branch. Since fetching and merging didn't modify this line. * DOC: Replace window.rst with file from pandas-dev master branch. To only add reverse rolling window section and avoid any unwanted changes. * DOC: Add section with reverse rolling window example. * DOC: Add section markup. Forgot to add. * DOC: Delete the same code example. FixedForwaredWindowIndexer example is same as the one above the added section. * DOC: Remove section and first sentence. Modify sentence slightly to show this example should output same result. * DOC: Remove unecessary words. Coding is already in Python.

@vangorade

* DOC: Add examples to do reversed rolling window (pandas-dev#38627). File is copied from @vangorade last changes in pull request (pandas-dev#39091): pandas-dev#39091 Fixed typo to pass pre-commit codespell hook. * DOC: Add some suggested changes. From pull request (pandas-dev#39091): pandas-dev#39091 - remove noqa - change line back to single quotes - rename df1 to reversed_df * DOC: Add reference to FixedForwardWindowIndexer. * DOC: Add more suggested changes. From pull request (pandas-dev#39091): pandas-dev#39091 - remove repeated df initialization in code example - rename df2 to reversed_df * DOC: Add suggested changes to reverse rolling window code examples (pandas-dev#38627). Move code example as suggested in pull request (pandas-dev#39091): pandas-dev#39091 Compiled document to check it looked fine by running: python make.py --single user_guide/window.rst * DOC: Revert more double quotes to single quotes. Unecessary changes. * DOC: Change binary window description to match master branch. Description was not modified after fetching and merging, so pasted from master branch: https://github.com/pandas-dev/pandas/blob/master/doc/source/user_guide/window.rst * DOC: Change exponentially weighted mean formula to one in master branch. Since fetching and merging didn't modify this line. * DOC: Replace window.rst with file from pandas-dev master branch. To only add reverse rolling window section and avoid any unwanted changes. * DOC: Add section with reverse rolling window example. * DOC: Add section markup. Forgot to add. * DOC: Delete the same code example. FixedForwaredWindowIndexer example is same as the one above the added section. * DOC: Remove section and first sentence. Modify sentence slightly to show this example should output same result. * DOC: Remove unecessary words. Coding is already in Python.

whitespaces

0beceaf

MarcoGorelli self-requested a review January 10, 2021 16:57

mroeschke reviewed Jan 11, 2021

View reviewed changes

jreback added Docs Window rolling, ewma, expanding labels Jan 11, 2021

MarcoGorelli suggested changes Jan 12, 2021

View reviewed changes

updated

80819f6

jreback requested changes Jan 13, 2021

View reviewed changes

MarcoGorelli mentioned this pull request Mar 4, 2021

add reverse rolling window example MarcoGorelli/pyladieslondon-sprints#6

Closed

github-actions bot added the Stale label Mar 14, 2021

mroeschke closed this Mar 14, 2021

mdhsieh added a commit to mdhsieh/pandas that referenced this pull request Jun 6, 2021

DOC: Add some suggested changes.

652fed4

From pull request (pandas-dev#39091): pandas-dev#39091 - remove noqa - change line back to single quotes - rename df1 to reversed_df

mdhsieh added a commit to mdhsieh/pandas that referenced this pull request Jun 6, 2021

DOC: Add more suggested changes.

243cc9f

From pull request (pandas-dev#39091): pandas-dev#39091 - remove repeated df initialization in code example - rename df2 to reversed_df

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Added reverse rolling window examples #39091

DOC: Added reverse rolling window examples #39091

vangorade commented Jan 10, 2021

mroeschke Jan 11, 2021

vangorade Jan 12, 2021

MarcoGorelli Jan 12, 2021 •

edited

Loading

mroeschke Jan 12, 2021

vangorade Jan 13, 2021

MarcoGorelli Jan 12, 2021

jreback Jan 13, 2021

jreback Jan 13, 2021

jreback Jan 13, 2021

jreback Jan 13, 2021

jreback Jan 13, 2021

jreback Jan 13, 2021

jreback Jan 13, 2021

jreback commented Jan 21, 2021

jreback commented Feb 11, 2021

github-actions bot commented Mar 14, 2021

mroeschke commented Mar 14, 2021

		# Using slicing
		# apply the rolling aggregation and then flip the result.


		indexer = pd.api.indexers.FixedForwardWindowIndexer(window_size=2)

		df2 = df.rolling(window=indexer, min_periods=1).sum()

DOC: Added reverse rolling window examples #39091

DOC: Added reverse rolling window examples #39091

Conversation

vangorade commented Jan 10, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MarcoGorelli Jan 12, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Jan 21, 2021

jreback commented Feb 11, 2021

github-actions bot commented Mar 14, 2021

mroeschke commented Mar 14, 2021

MarcoGorelli Jan 12, 2021 •

edited

Loading