|
1 | 1 | #' Initiate a plotly visualization
|
2 | 2 | #'
|
3 |
| -#' This function maps R objects to [plotly.js](https://plot.ly/javascript/), |
| 3 | +#' This function maps R objects to [plotly.js](https://plotly.com/javascript/), |
4 | 4 | #' an (MIT licensed) web-based interactive charting library. It provides
|
5 | 5 | #' abstractions for doing common things (e.g. mapping data values to
|
6 | 6 | #' fill colors (via `color`) or creating [animation]s (via `frame`)) and sets
|
|
27 | 27 | #' only have one name, this argument acts very much like `split` in that it
|
28 | 28 | #' creates one trace for every unique value.
|
29 | 29 | #' @param color Values mapped to relevant 'fill-color' attribute(s)
|
30 |
| -#' (e.g. [fillcolor](https://plotly.com/r/reference#scatter-fillcolor), |
31 |
| -#' [marker.color](https://plotly.com/r/reference#scatter-marker-color), |
| 30 | +#' (e.g. [fillcolor](https://plotly.com/r/reference/#scatter-fillcolor), |
| 31 | +#' [marker.color](https://plotly.com/r/reference/#scatter-marker-color), |
32 | 32 | #' [textfont.color](https://plotly.com/r/reference/#scatter-textfont-color), etc.).
|
33 | 33 | #' The mapping from data values to color codes may be controlled using
|
34 | 34 | #' `colors` and `alpha`, or avoided altogether via [I()] (e.g., `color = I("red")`).
|
|
37 | 37 | #' or a vector of colors to interpolate in hexadecimal "#RRGGBB" format,
|
38 | 38 | #' or a color interpolation function like `colorRamp()`.
|
39 | 39 | #' @param stroke Similar to `color`, but values are mapped to relevant 'stroke-color' attribute(s)
|
40 |
| -#' (e.g., [marker.line.color](https://plotly.com/r/reference#scatter-marker-line-color) |
41 |
| -#' and [line.color](https://plotly.com/r/reference#scatter-line-color) |
| 40 | +#' (e.g., [marker.line.color](https://plotly.com/r/reference/#scatter-marker-line-color) |
| 41 | +#' and [line.color](https://plotly.com/r/reference/#scatter-line-color) |
42 | 42 | #' for filled polygons). If not specified, `stroke` inherits from `color`.
|
43 | 43 | #' @param strokes Similar to `colors`, but controls the `stroke` mapping.
|
44 | 44 | #' @param alpha A number between 0 and 1 specifying the alpha channel applied to `color`.
|
45 |
| -#' Defaults to 0.5 when mapping to [fillcolor](https://plotly.com/r/reference#scatter-fillcolor) and 1 otherwise. |
| 45 | +#' Defaults to 0.5 when mapping to [fillcolor](https://plotly.com/r/reference/#scatter-fillcolor) and 1 otherwise. |
46 | 46 | #' @param alpha_stroke Similar to `alpha`, but applied to `stroke`.
|
47 |
| -#' @param symbol (Discrete) values mapped to [marker.symbol](https://plotly.com/r/reference#scatter-marker-symbol). |
| 47 | +#' @param symbol (Discrete) values mapped to [marker.symbol](https://plotly.com/r/reference/#scatter-marker-symbol). |
48 | 48 | #' The mapping from data values to symbols may be controlled using
|
49 | 49 | #' `symbols`, or avoided altogether via [I()] (e.g., `symbol = I("pentagon")`).
|
50 |
| -#' Any [pch] value or [symbol name](https://plotly.com/r/reference#scatter-marker-symbol) may be used in this way. |
51 |
| -#' @param symbols A character vector of [pch] values or [symbol names](https://plotly.com/r/reference#scatter-marker-symbol). |
52 |
| -#' @param linetype (Discrete) values mapped to [line.dash](https://plotly.com/r/reference#scatter-line-dash). |
| 50 | +#' Any [pch] value or [symbol name](https://plotly.com/r/reference/#scatter-marker-symbol) may be used in this way. |
| 51 | +#' @param symbols A character vector of [pch] values or [symbol names](https://plotly.com/r/reference/#scatter-marker-symbol). |
| 52 | +#' @param linetype (Discrete) values mapped to [line.dash](https://plotly.com/r/reference/#scatter-line-dash). |
53 | 53 | #' The mapping from data values to symbols may be controlled using
|
54 | 54 | #' `linetypes`, or avoided altogether via [I()] (e.g., `linetype = I("dash")`).
|
55 |
| -#' Any `lty` (see [par]) value or [dash name](https://plotly.com/r/reference#scatter-line-dash) may be used in this way. |
56 |
| -#' @param linetypes A character vector of `lty` values or [dash names](https://plotly.com/r/reference#scatter-line-dash) |
| 55 | +#' Any `lty` (see [par]) value or [dash name](https://plotly.com/r/reference/#scatter-line-dash) may be used in this way. |
| 56 | +#' @param linetypes A character vector of `lty` values or [dash names](https://plotly.com/r/reference/#scatter-line-dash) |
57 | 57 | #' @param size (Numeric) values mapped to relevant 'fill-size' attribute(s)
|
58 |
| -#' (e.g., [marker.size](https://plotly.com/r/reference#scatter-marker-size), |
59 |
| -#' [textfont.size](https://plotly.com/r/reference#scatter-textfont-size), |
60 |
| -#' and [error_x.width](https://plotly.com/r/reference#scatter-error_x-width)). |
| 58 | +#' (e.g., [marker.size](https://plotly.com/r/reference/#scatter-marker-size), |
| 59 | +#' [textfont.size](https://plotly.com/r/reference/#scatter-textfont-size), |
| 60 | +#' and [error_x.width](https://plotly.com/r/reference/#scatter-error_x-width)). |
61 | 61 | #' The mapping from data values to symbols may be controlled using
|
62 | 62 | #' `sizes`, or avoided altogether via [I()] (e.g., `size = I(30)`).
|
63 | 63 | #' @param sizes A numeric vector of length 2 used to scale `size` to pixels.
|
64 | 64 | #' @param span (Numeric) values mapped to relevant 'stroke-size' attribute(s)
|
65 | 65 | #' (e.g.,
|
66 |
| -#' [marker.line.width](https://plotly.com/r/reference#scatter-marker-line-width), |
67 |
| -#' [line.width](https://plotly.com/r/reference#scatter-line-width) for filled polygons, |
68 |
| -#' and [error_x.thickness](https://plotly.com/r/reference#scatter-error_x-thickness)) |
| 66 | +#' [marker.line.width](https://plotly.com/r/reference/#scatter-marker-line-width), |
| 67 | +#' [line.width](https://plotly.com/r/reference/#scatter-line-width) for filled polygons, |
| 68 | +#' and [error_x.thickness](https://plotly.com/r/reference/#scatter-error_x-thickness)) |
69 | 69 | #' The mapping from data values to symbols may be controlled using
|
70 | 70 | #' `spans`, or avoided altogether via [I()] (e.g., `span = I(30)`).
|
71 | 71 | #' @param spans A numeric vector of length 2 used to scale `span` to pixels.
|
|
0 commit comments