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

Documentation - errors in details section of plot.xts.Rd does not reflect match.arg values for ticks #291

Closed
harvey131 opened this issue Apr 1, 2019 · 1 comment
Labels
Milestone

Comments

@harvey131
Copy link

harvey131 commented Apr 1, 2019

plot.xts.Rd documentation is incorrect in 'details' section. It says possible values to 'major.ticks', etc.. can be named 'yearly' but the axTicksByTime() looks for values named 'years', not 'yearly'.

\details{
  Possible values for arguments \code{major.ticks}, \code{minor.ticks},
  and \code{grid.ticks.on} include \sQuote{auto}, \sQuote{minute},
  \sQuote{hourly}, \sQuote{daily}, \sQuote{weekly}, \sQuote{monthly},
  \sQuote{quarterly}, and \sQuote{yearly}. The default is \sQuote{auto}, which
  attempts to determine sensible locations from the periodicity and locations
  of observations. The other values are based on the output from
  \code{periodicity}.
}

Please change documentation to use the same values in axTicksByTime():

tick.opts <- c("years", "quarters", "months", "weeks", "days", "hours", "minutes", "seconds")

Updated version:

\details{
  Possible values for arguments \code{major.ticks}, \code{minor.ticks},
  and \code{grid.ticks.on} include \sQuote{auto}, \sQuote{minutes},
  \sQuote{hours}, \sQuote{days}, \sQuote{weeks}, \sQuote{months},
  \sQuote{quarters}, and \sQuote{years}. The default is \sQuote{auto}, which
  attempts to determine sensible locations from the periodicity and locations
  of observations. The other values are based on the output from
  \code{periodicity}.
}
@joshuaulrich
Copy link
Owner

joshuaulrich commented Apr 2, 2019

Thanks for the report! I agree the documentation should be corrected. We also need to update the Details section that says the "ticks" argument values are based on the output of periodicity(). The periodicity() output uses the "*ly" versions.

Ideally, we should be consistent and use one or the other (i.e "hours" or "hourly") everywhere.

@joshuaulrich joshuaulrich added this to the 0.12-0 milestone Jul 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants