Skip to content

Commit d5359a6

Browse files
mkcormkcor
committed
Re-run roxygen2::roxygenise()
1 parent 9b90c96 commit d5359a6

6 files changed

Lines changed: 37 additions & 58 deletions

File tree

‎NAMESPACE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Generated by roxygen2 (4.0.1): do not edit by hand
22

33
export(gg2list)
4-
export(group2NA)
54
export(layer2traces)
5+
export(now)
66
export(paramORdefault)
77
export(plotly)
88
export(set_credentials_file)

‎man/aes2marker.Rd‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
\name{aes2marker}
44
\alias{aes2marker}
55
\title{Convert ggplot2 aes to plotly "marker" codes.}
6-
\format{\preformatted{ Named chr [1:4] "opacity" "color" "size" "symbol"
7-
- attr(*, "names")= chr [1:4] "alpha" "colour" "size" "shape"
6+
\format{\preformatted{ Named chr [1:6] "opacity" "color" "size" "sizeref" "sizemode" "symbol"
7+
- attr(*, "names")= chr [1:6] "alpha" "colour" "size" "sizeref" ...
88
}}
99
\usage{
1010
aes2marker

‎man/geom2trace.Rd‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@
33
\name{geom2trace}
44
\alias{geom2trace}
55
\title{Convert basic geoms to traces.}
6-
\format{\preformatted{List of 5
7-
$ path :function (data, params)
8-
$ polygon:function (data, params)
9-
$ point :function (data, params)
10-
$ bar :function (data, params)
11-
$ step :function (data, params)
6+
\format{\preformatted{List of 6
7+
$ path :function (data, params)
8+
$ polygon :function (data, params)
9+
$ point :function (data, params)
10+
$ bar :function (data, params)
11+
$ step :function (data, params)
12+
$ histogram:function (data, params)
1213
}}
1314
\usage{
1415
geom2trace

‎man/group2NA.Rd‎

Lines changed: 0 additions & 26 deletions
This file was deleted.

‎man/layer2traces.Rd‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
\alias{layer2traces}
44
\title{Convert a layer to a list of traces. Called from gg2list()}
55
\usage{
6-
layer2traces(l, d, misc)
6+
layer2traces(l, d, misc, plot = NULL)
77
}
88
\arguments{
99
\item{l}{one layer of the ggplot object}

‎man/plotly.Rd‎

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,58 +3,62 @@
33
\alias{plotly}
44
\title{Main interface to plotly}
55
\usage{
6-
plotly(username = NULL, key = NULL)
6+
plotly(username = NULL, key = NULL, base.url = "https://plot.ly")
77
}
88
\arguments{
99
\item{username}{plotly username}
1010

1111
\item{key}{plotly API key}
12+
13+
\item{base.url}{plotly server}
1214
}
1315
\value{
14-
An object of class PlotlyClass, except for the final object after adding
15-
layers becomes a list class.
16+
An object of class PlotlyClass, except for the final object after
17+
adding layers becomes a list class.
1618
}
1719
\description{
18-
A call to \code{plotly(username, key)} creates an object of class 'PlotlyClass', which
19-
has 3 methods:
20+
A call to \code{plotly(username, key)} creates an object of class
21+
'PlotlyClass', which has methods:
2022
\itemize{
21-
\item Plotting: py$plotly(x1, y1[,x2,y2,...], kwargs=kw) or
22-
py$plotly({data1[,data2,...]}, kwargs=kwargs)
23+
\item Plotting: py$plotly(x1, y1[, x2, y2, ...], kwargs=kwargs) or
24+
py$plotly({data1[, data2, ...]}, kwargs=kwargs), py$ggplotly()
2325
\item Styling Data: py$style(data1,data2,..., kwargs=kwargs)
2426
\item Styling Layout: py$layout(layout, kwargs=kwargs)
27+
\item Utilities: py$get_figure(file_owner, file_id)
2528
}
2629
}
2730
\details{
28-
Plotly interface object. See up-to-date documentation and examples at https://plot.ly/API
31+
Plotly interface object. See up-to-date documentation and examples at
32+
https://plot.ly/API
2933

3034
See documentation and examples at https://plot.ly/API
3135
}
3236
\examples{
3337
\dontrun{
3438
## View https://plot.ly/API for more examples
3539
## Generate a simple plot
36-
username <- 'anna.lyst' # fill in with your plotly username
37-
api_key <- 'y37zkd' # fill in with your plotly API key
40+
username <- 'anna.lyst' # fill in with your plotly username
41+
api_key <- 'y37zkd' # fill in with your plotly API key
3842
py <- plotly(username, api_key)
3943
## generate some data
40-
x <- c(0,1,2)
41-
y <- c(10,11,12)
44+
x <- c(0, 1, 2)
45+
y <- c(10, 11, 12)
4246

43-
## Send data to Plotly. Plotly will render an interactive graph and will return a
44-
## URL where you can view your plot
47+
## Send data to Plotly. Plotly will render an interactive graph and will
48+
## return a URL where you can view your plot
4549
## This call sends data to Plotly, Plotly renders an interactive
46-
## graph, and returns a URL where you can view your plot
47-
response <- py$plot(x,y)
48-
response$url # view your plot at this URL
49-
browseURL(response$url) # use browseURL to go to the URL in your browser
50+
## graph, and returns a URL where you can view your plot
51+
response <- py$plot(x, y)
52+
response$url # view your plot at this URL
53+
browseURL(response$url) # use browseURL to go to the URL in your browser
5054

51-
## Export ggplots directly to plot.ly.
55+
## Export ggplots directly to plot.ly
5256
ggiris <- qplot(Petal.Width, Sepal.Length, data=iris, color=Species)
5357
py$ggplotly(ggiris)
5458
data(canada.cities, package="maps")
55-
viz <- ggplot(canada.cities, aes(long, lat))+
56-
borders(regions="canada", name="borders")+
57-
coord_equal()+
59+
viz <- ggplot(canada.cities, aes(long, lat)) +
60+
borders(regions="canada", name="borders") +
61+
coord_equal() +
5862
geom_point(aes(text=name, size=pop), colour="red",
5963
alpha=1/2, name="cities")
6064
py$ggplotly(viz)

0 commit comments

Comments
 (0)