EVOLUTION-MANAGER
Edit File: axTicksByTime.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Compute x-Axis Tickmark Locations by Time</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <link rel="stylesheet" type="text/css" href="R.css" /> </head><body> <table width="100%" summary="page for axTicksByTime {xts}"><tr><td>axTicksByTime {xts}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2> Compute x-Axis Tickmark Locations by Time </h2> <h3>Description</h3> <p>Compute x-axis tickmarks like <code>axTicks</code> in base but with respect to time. Additionally the first argument is the object indexed by time which you are looking to derive tickmark locations for. </p> <p>It is possible to specify the detail you are seeking, or by passing 'auto' to the <code>ticks.on</code> argument, to get a best heuristic fit. </p> <h3>Usage</h3> <pre> axTicksByTime(x, ticks.on='auto', k = 1, labels=TRUE, format.labels=TRUE, ends=TRUE, gt = 2, lt = 30) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>x</code></td> <td> <p> the object indexed by time, or a vector of times/dates </p> </td></tr> <tr valign="top"><td><code>ticks.on</code></td> <td> <p> what to break on </p> </td></tr> <tr valign="top"><td><code>k</code></td> <td> <p> frequency of breaks </p> </td></tr> <tr valign="top"><td><code>labels</code></td> <td> <p> should a labeled vector be returned </p> </td></tr> <tr valign="top"><td><code>format.labels</code></td> <td> <p> format labels - may be format to use </p> </td></tr> <tr valign="top"><td><code>ends</code></td> <td> <p> should the ends be adjusted </p> </td></tr> <tr valign="top"><td><code>gt</code></td> <td> <p> lower bound on number of breaks </p> </td></tr> <tr valign="top"><td><code>lt</code></td> <td> <p> upper bound on number of breaks </p> </td></tr> </table> <h3>Details</h3> <p>This function is written for internal use, and documented for those wishing to use outside of the internal function uses. In general it is most unlikely that the end user will call this function directly. </p> <p>The <code>format.labels</code> argument allows for standard formatting like that used in <code>format</code>, <code>strptime</code>, and <code>strftime</code>. </p> <h3>Value</h3> <p>A numeric vector of index element locations where tick marks should be drawn. These are <em>locations</em> (e.g. 1, 2, 3, ...), <em>not</em> the index timestamps. </p> <p>If possible, the result will be named using formatted values from the index timestamps. The names will be used for the tick mark labels. </p> <h3>Author(s)</h3> <p> Jeffrey A. Ryan </p> <h3>See Also</h3> <p><code><a href="endpoints.html">endpoints</a></code> </p> <h3>Examples</h3> <pre> data(sample_matrix) axTicksByTime(as.xts(sample_matrix),'auto') axTicksByTime(as.xts(sample_matrix),'weeks') axTicksByTime(as.xts(sample_matrix),'months',7) </pre> <hr /><div style="text-align: center;">[Package <em>xts</em> version 0.12.2 <a href="00Index.html">Index</a>]</div> </body></html>