joshuaulrich / xts

Extensible time series class that provides uniform handling of many R time series classes by extending zoo.
http://joshuaulrich.github.io/xts/
GNU General Public License v2.0
220 stars 71 forks source link

axTicksByTime help file #354

Closed ggrothendieck closed 3 years ago

ggrothendieck commented 3 years ago

The axTicksByTime help file defines the value returned as A vector of index points to break on, possibly with the index names. Here index refers to the 1, 2, 3, ... and not the time index. It needs to be clarified what is being referred to.

joshuaulrich commented 3 years ago

Thanks for the report! I'll propose an update in this issue. It would be great if you could let me know if it clarifies the usage.

joshuaulrich commented 3 years ago

@ggrothendieck, how about this?

A numeric vector of index locations where tick marks should be drawn. If possible, the result will have names based on formatted values from the index time stamps.

ggrothendieck commented 3 years ago

Suggest that it explicitly refer 1, 2, 3, ... and explicitly point out this is NOT user coordinates.

joshuaulrich commented 3 years ago

Second try:

A numeric vector of index element locations where tick marks should be drawn. These are \emph{locations} (e.g. 1, 2, 3, ...), \emph{not} the index timestamps.

If possible, the result will be named using formatted values from the index timestamps. The names will be used for the tick mark labels.

Please feel free to suggest your own description. It would be very helpful.

ggrothendieck commented 3 years ago

looks ok.

On Tue, Jun 8, 2021 at 8:26 AM Joshua Ulrich @.***> wrote:

Second try:

A numeric vector of index element locations where tick marks should be drawn. These are \emph{locations} (e.g. 1, 2, 3, ...), \emph{not} the index timestamps.

If possible, the result will be named using formatted values from the index timestamps. The names will be used for the tick mark labels.

Please feel free to suggest your own description. It would be very helpful.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/joshuaulrich/xts/issues/354#issuecomment-856721094, or unsubscribe https://github.com/notifications/unsubscribe-auth/AB32F7VBZBGN2J2TUBL4KYDTRYEAHANCNFSM46AXFUUQ .

-- Statistics & Software Consulting GKX Group, GKX Associates Inc. tel: 1-877-GKX-GROUP email: ggrothendieck at gmail.com