Skip to content
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

add more time of day subsetting information to the documentation #304

Closed
braverock opened this issue Jul 28, 2019 · 1 comment · Fixed by #328
Closed

add more time of day subsetting information to the documentation #304

braverock opened this issue Jul 28, 2019 · 1 comment · Fixed by #328
Milestone

Comments

@braverock
Copy link
Contributor

braverock commented Jul 28, 2019

Description

Time of day subsetting ['T08:00/T15:00'] has been supported by xts since 2008.

There is one question in the xts FAQ which discusses time of day subsetting, but nothing in the function documentation.

Add this information to the [.xts documentation, and add [.xts to the seealso for xts documentation.

Additional subsetting information could probably be added as well to assist users trying to figure things out.

@joshuaulrich
Copy link
Owner

joshuaulrich commented Jul 28, 2019

Great suggestion! We need to make sure to document the required format "THH:MM:SS/THH:MM:SS" with emphasis on the leading "T" and leading zero. We should also make sure that [.xts is linked to xts in the SeeAlso section.

It might also help to note what currently doesn't work. For example, subsetting by a single time ("THH:MM"), and open-ended intervals ("/THH:MM"). And discuss what happens when the start of the interval is a time greater than the end of the interval (i.e. the behavior described in this commit).

@joshuaulrich joshuaulrich added this to the 0.12-0 milestone Aug 4, 2019
claymoremarshall pushed a commit to claymoremarshall/xts that referenced this issue Feb 23, 2020
Expand the examples in the documentation for subset.xts and tclass.

In subset.xts extend \{seealso to include .index as both help
pages relate to subsetting.

In tclass, provide examples for each kind of subsetting available.

Fixes Issue joshuaulrich#304
claymoremarshall pushed a commit to claymoremarshall/xts that referenced this issue Feb 23, 2020
Expand the examples in the documentation for subset.xts.Rd andd
tclass.Rd

In subset.xts.Rd, extend \{seealso to include ?.index as both help
pages relate to subsetting.

In tclass.Rd, provide examples for each kind of subsetting available.

Fixes Issue joshuaulrich#304
claymoremarshall pushed a commit to claymoremarshall/xts that referenced this issue Feb 23, 2020
Expand the examples in the documentation for subset.xts.Rd andd
tclass.Rd

In subset.xts.Rd, extend \{seealso to include ?.index as both help
pages relate to subsetting.

In tclass.Rd, provide examples for each kind of subsetting available.

Fixes Issue joshuaulrich#304
claymoremarshall pushed a commit to claymoremarshall/xts that referenced this issue Feb 23, 2020
Expand the examples in the documentation for subset.xts.Rd andd
tclass.Rd

In subset.xts.Rd, extend \{seealso to include ?.index as both help
pages relate to subsetting.

In tclass.Rd, provide examples for each kind of subsetting available.

Fixes Issue joshuaulrich#304
@joshuaulrich joshuaulrich modified the milestones: 0.12-0, 0.12-1 Jul 12, 2020
joshuaulrich pushed a commit that referenced this issue Sep 5, 2020
Expand the examples in the documentation for subset.xts.Rd andd
tclass.Rd

In subset.xts.Rd, extend \{seealso to include ?.index as both help
pages relate to subsetting.

In tclass.Rd, provide examples for each kind of subsetting available.

Fixes Issue #304
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants