Ran roxygenize() from roxygen2

mkcor · mkcor · commit 1e13bc79fef2 · 2014-05-22T13:50:21.000-04:00
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,8 +1,12 @@
+# Generated by roxygen2 (4.0.1): do not edit by hand
+
 export(gg2list)
 export(group2NA)
 export(layer2traces)
 export(paramORdefault)
 export(plotly)
+export(set_credentials_file)
+export(show_credentials_file)
 export(signup)
 export(toRGB)
 import(RCurl)
diff --git a/R/tools.R b/R/tools.R
@@ -44,6 +44,7 @@ get_credentials_file <- function(args=c()) {
 
 
 #' Read and print Plotly credentials file, wrapping get_credentials_file()
+#' @export
 show_credentials_file <- function(args=c()) {
   print("Your credentials file:")
   print(get_credentials_file(args))
@@ -55,6 +56,7 @@ show_credentials_file <- function(args=c()) {
 #' @param api_key
 #' @param stream_ids
 #' @return List of keyword-value pairs (credentials)
+#' @export
 #' @examples
 #' \dontrun{
 #' set_credentials_file("username", "api_key", list("foo", "bar))
diff --git a/man/aes2line.Rd b/man/aes2line.Rd
@@ -1,9 +1,10 @@
+% Generated by roxygen2 (4.0.1): do not edit by hand
 \docType{data}
 \name{aes2line}
 \alias{aes2line}
 \title{Convert ggplot2 aes to line parameters.}
-\format{\preformatted{ Named chr [1:3] "dash" "color" "width"
- - attr(*, "names")= chr [1:3] "linetype" "colour" "size"
+\format{\preformatted{ Named chr [1:4] "dash" "color" "width" "shape"
+ - attr(*, "names")= chr [1:4] "linetype" "colour" "size" "direction"
 }}
 \usage{
 aes2line
diff --git a/man/aes2marker.Rd b/man/aes2marker.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.1): do not edit by hand
 \docType{data}
 \name{aes2marker}
 \alias{aes2marker}
diff --git a/man/geom2trace.Rd b/man/geom2trace.Rd
@@ -1,11 +1,14 @@
+% Generated by roxygen2 (4.0.1): do not edit by hand
 \docType{data}
 \name{geom2trace}
 \alias{geom2trace}
 \title{Convert basic geoms to traces.}
-\format{\preformatted{List of 3
+\format{\preformatted{List of 5
  $ path   :function (data, params)  
  $ polygon:function (data, params)  
  $ point  :function (data, params)  
+ $ bar    :function (data, params)
+ $ step   :function (data, params)
 }}
 \usage{
 geom2trace
diff --git a/man/gg2list.Rd b/man/gg2list.Rd
@@ -1,11 +1,12 @@
+% Generated by roxygen2 (4.0.1): do not edit by hand
 \name{gg2list}
 \alias{gg2list}
 \title{Convert a ggplot to a list.}
 \usage{
 gg2list(p)
 }
 \arguments{
-  \item{p}{ggplot2 plot.}
+\item{p}{ggplot2 plot.}
 }
 \value{
 list representing a ggplot.
diff --git a/man/group2NA.Rd b/man/group2NA.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.1): do not edit by hand
 \name{group2NA}
 \alias{group2NA}
 \title{Drawing ggplot2 geoms with a group aesthetic is most efficient in
@@ -7,17 +8,17 @@ vectors with NA.}
 group2NA(g, geom)
 }
 \arguments{
-  \item{g}{list of geom info with g$data$group.}
+\item{g}{list of geom info with g$data$group.}
 
-  \item{geom}{change g$geom to this.}
+\item{geom}{change g$geom to this.}
 }
 \value{
 list of geom info.
 }
 \description{
-Drawing ggplot2 geoms with a group aesthetic is most
-efficient in plotly when we convert groups of things that
-look the same to vectors with NA.
+Drawing ggplot2 geoms with a group aesthetic is most efficient in
+plotly when we convert groups of things that look the same to
+vectors with NA.
 }
 \author{
 Toby Dylan Hocking
diff --git a/man/layer2traces.Rd b/man/layer2traces.Rd
@@ -1,20 +1,19 @@
+% Generated by roxygen2 (4.0.1): do not edit by hand
 \name{layer2traces}
 \alias{layer2traces}
 \title{Convert a layer to a list of traces. Called from gg2list()}
 \usage{
 layer2traces(l, d, misc)
 }
 \arguments{
-  \item{l}{one layer of the ggplot object}
+\item{l}{one layer of the ggplot object}
 
-  \item{d}{one layer of calculated data from
-  ggplot2::ggplot_build(p)}
+\item{d}{one layer of calculated data from ggplot2::ggplot_build(p)}
 
-  \item{misc}{named list.}
+\item{misc}{named list.}
 }
 \value{
-list representing a layer, with corresponding aesthetics,
-ranges, and groups.
+list representing a layer, with corresponding aesthetics, ranges, and groups.
 }
 \description{
 Convert a layer to a list of traces. Called from gg2list()
diff --git a/man/lty2dash.Rd b/man/lty2dash.Rd
@@ -1,8 +1,9 @@
+% Generated by roxygen2 (4.0.1): do not edit by hand
 \docType{data}
 \name{lty2dash}
 \alias{lty2dash}
 \title{Convert R lty line type codes to plotly "dash" codes.}
-\format{\preformatted{ Named chr [1:25] "solid" "dash" "dot" "dashdot" "longdash" ...
+\format{\preformatted{ Named chr [1:25] "solid" "dash" "dot" "dashdot" "longdash" "longdashdot" ...
  - attr(*, "names")= chr [1:25] "1" "2" "3" "4" ...
 }}
 \usage{
diff --git a/man/paramORdefault.Rd b/man/paramORdefault.Rd
@@ -1,16 +1,16 @@
+% Generated by roxygen2 (4.0.1): do not edit by hand
 \name{paramORdefault}
 \alias{paramORdefault}
 \title{convert ggplot params to plotly.}
 \usage{
 paramORdefault(params, aesVec, defaults)
 }
 \arguments{
-  \item{params}{named list ggplot names -> values.}
+\item{params}{named list ggplot names -> values.}
 
-  \item{aesVec}{vector mapping ggplot names to plotly
-  names.}
+\item{aesVec}{vector mapping ggplot names to plotly names.}
 
-  \item{defaults}{named list ggplot names -> values.}
+\item{defaults}{named list ggplot names -> values.}
 }
 \value{
 named list.
diff --git a/man/pch2symbol.Rd b/man/pch2symbol.Rd
@@ -1,8 +1,9 @@
+% Generated by roxygen2 (4.0.1): do not edit by hand
 \docType{data}
 \name{pch2symbol}
 \alias{pch2symbol}
 \title{Convert R pch point codes to plotly "symbol" codes.}
-\format{\preformatted{ Named chr [1:20] "square" "circle" "triangle-up" "cross" "x" ...
+\format{\preformatted{ Named chr [1:20] "square" "circle" "triangle-up" "cross" "x" "diamond" ...
  - attr(*, "names")= chr [1:20] "0" "1" "2" "3" ...
 }}
 \usage{
diff --git a/man/plotly-package.Rd b/man/plotly-package.Rd
@@ -1,32 +1,35 @@
+% Generated by roxygen2 (4.0.1): do not edit by hand
 \docType{package}
 \name{plotly-package}
 \alias{plotly-package}
 \title{A R API for plot.ly}
 \description{
-plot.ly is a browser-based data visualization tool that
-creates interactive and publication quality figures. This
-API allows R users to generate plot.ly graphs from their
-desktop R environment.
+plot.ly is a browser-based data visualization tool that creates interactive and publication
+quality figures. This API allows R users to generate plot.ly graphs from their desktop
+R environment.
 }
 \details{
-An example of an interactive graph made from the R API:
-https://plot.ly/~chris/407/
+An example of an interactive graph made from the R API: https://plot.ly/~chris/407/
 
-\itemize{ \item Package: plotly \item Type: Package \item
-Version: 0.3.4 \item Date: 2014-03-07 \item License: MIT }
+\itemize{
+ \item Package: plotly
+ \item Type: Package
+ \item Version: 0.3.4
+ \item Date: 2014-03-07
+ \item License: MIT
+}
 }
 \section{Authentication}{
-  There are a few different options. First, you can pass in
-  your username and key to the \code{plotly} function as
-  parameters, like \code{plotly(<yourusername>,
-  <yourkey>)}. Second, you can set your username and key as
-  options temporarily within each R session by executing
-  \code{options(plotlyUsername='<yourusername>')} and
-  \code{options(plotlyKey='<yourkey>')}. Third, you set
-  your username and key permanently (until removed) in your
-  .Rprofile file. Put entries in for each of username and
-  password: \code{options(plotlyUsername='<yourusername>')}
-  and \code{options(plotlyKey='<yourkey>')}.
+
+
+There are a few different options. First, you can pass in your username and key
+to the \code{plotly} function as parameters, like \code{plotly(<yourusername>,
+<yourkey>)}. Second, you can set your username and key as options temporarily
+within each R session by executing \code{options(plotlyUsername='<yourusername>')}
+and \code{options(plotlyKey='<yourkey>')}. Third, you set your username and key
+permanently (until removed) in your .Rprofile file. Put entries in for each of
+username and password: \code{options(plotlyUsername='<yourusername>')} and
+\code{options(plotlyKey='<yourkey>')}.
 }
 \author{
 Chris Parmer chris@plot.ly
diff --git a/man/plotly.Rd b/man/plotly.Rd
@@ -1,29 +1,31 @@
+% Generated by roxygen2 (4.0.1): do not edit by hand
 \name{plotly}
 \alias{plotly}
 \title{Main interface to plotly}
 \usage{
 plotly(username = NULL, key = NULL)
 }
 \arguments{
-  \item{username}{plotly username}
+\item{username}{plotly username}
 
-  \item{key}{plotly API key}
+\item{key}{plotly API key}
 }
 \value{
-An object of class PlotlyClass, except for the final object
-after adding layers becomes a list class.
+An object of class PlotlyClass, except for the final object after adding
+layers becomes a list class.
 }
 \description{
-A call to \code{plotly(username, key)} creates an object of
-class 'PlotlyClass', which has 3 methods: \itemize{ \item
-Plotting: py$plotly(x1, y1[,x2,y2,...], kwargs=kw) or
-py$plotly({data1[,data2,...]}, kwargs=kwargs) \item Styling
-Data: py$style(data1,data2,..., kwargs=kwargs) \item
-Styling Layout: py$layout(layout, kwargs=kwargs) }
+A call to \code{plotly(username, key)} creates an object of class 'PlotlyClass', which
+has 3 methods:
+\itemize{
+ \item Plotting: py$plotly(x1, y1[,x2,y2,...], kwargs=kw) or
+   py$plotly({data1[,data2,...]}, kwargs=kwargs)
+ \item Styling Data: py$style(data1,data2,..., kwargs=kwargs)
+ \item Styling Layout: py$layout(layout, kwargs=kwargs)
+}
 }
 \details{
-Plotly interface object. See up-to-date documentation and
-examples at https://plot.ly/API
+Plotly interface object. See up-to-date documentation and examples at https://plot.ly/API
 
 See documentation and examples at https://plot.ly/API
 }
diff --git a/man/signup.Rd b/man/signup.Rd
@@ -1,21 +1,24 @@
+% Generated by roxygen2 (4.0.1): do not edit by hand
 \name{signup}
 \alias{signup}
 \title{Sign up to plotly.}
 \usage{
 signup(username = NULL, email = NULL)
 }
 \arguments{
-  \item{username}{Desired username}
+\item{username}{Desired username}
 
-  \item{email}{Desired email}
+\item{email}{Desired email}
 }
 \value{
-\itemize{ \item api_key key to use with the api \item
-tmp_pw temporary password to access your plotly account }
+\itemize{
+ \item api_key key to use with the api
+ \item tmp_pw temporary password to access your plotly account
+}
 }
 \description{
-A sign up interface to Plotly through the R Console. See
-documentation and examples at https://plot.ly/API
+A sign up interface to Plotly through the R Console. See documentation and
+examples at https://plot.ly/API
 }
 \details{
 See documentation and examples at https://plot.ly/API
diff --git a/man/toRGB.Rd b/man/toRGB.Rd
@@ -1,15 +1,15 @@
+% Generated by roxygen2 (4.0.1): do not edit by hand
 \name{toRGB}
 \alias{toRGB}
 \title{Convert R colors to RGB hexadecimal color values}
 \usage{
 toRGB(x)
 }
 \arguments{
-  \item{x}{character}
+\item{x}{character}
 }
 \value{
-hexadecimal color value (if is.na(x), return "none" for
-compatibility with JavaScript)
+hexadecimal color value (if is.na(x), return "none" for compatibility with JavaScript)
 }
 \description{
 Convert R colors to RGB hexadecimal color values

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+% Generated by roxygen2 (4.0.1): do not edit by hand`
`1`	`2`	`\docType{data}`
`2`	`3`	`\name{aes2marker}`
`3`	`4`	`\alias{aes2marker}`
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,12 @@`
	`1`	`+% Generated by roxygen2 (4.0.1): do not edit by hand`
`1`	`2`	`\name{gg2list}`
`2`	`3`	`\alias{gg2list}`
`3`	`4`	`\title{Convert a ggplot to a list.}`
`4`	`5`	`\usage{`
`5`	`6`	`gg2list(p)`
`6`	`7`	`}`
`7`	`8`	`\arguments{`
`8`		`- \item{p}{ggplot2 plot.}`
	`9`	`+\item{p}{ggplot2 plot.}`
`9`	`10`	`}`
`10`	`11`	`\value{`
`11`	`12`	`list representing a ggplot.`