small edits

Author: sckott

R/plotly-package.r

@@ -2,7 +2,7 @@
 #' quality figures. This API allows R users to generate plot.ly graphs from their desktop 
 #' R environment.
 #' 
-#' Here is 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
@@ -12,6 +12,17 @@
 #'  \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>')}. 
+#' 
 #' @author Chris Parmer chris@@plot.ly
 #' @references Documentation and examples at https://plot.ly/API
 #' @name plotly-package

R/plotly.R

@@ -16,7 +16,8 @@
 #' @param username plotly username
 #' @param key plotly API key
 #' 
-#' @return An object of class PlotlyClass
+#' @return An object of class PlotlyClass, except for the final object after adding
+#' layers becomes a list class.
 #' @details See documentation and examples at https://plot.ly/API
 #' @references https://plot.ly/API
 #' @author Chris Parmer chris@@plot.ly
@@ -36,8 +37,8 @@
 #' ## This call sends data to Plotly, Plotly renders an interactive 
 #' ##    graph, and returns a URL where you can view your plot
 #' response <- py$plot(x,y)
-#' url = response$url # view your plot at this URL
-#' browseURL(url)
+#' response$url # view your plot at this URL
+#' browseURL(response$url) # use browseURL to go to the URL in your browser
 #' }
 
 plotly <- function(username=NULL, key=NULL){

man/plotly-package.Rd

@@ -9,12 +9,25 @@ API allows R users to generate plot.ly graphs from their
 desktop R environment.
 }
 \details{
-Here is 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-06 \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>')}.
+}
 \author{
 Chris Parmer chris@plot.ly
 }

man/plotly.Rd

@@ -10,7 +10,8 @@ plotly(username = NULL, key = NULL)
   \item{key}{plotly API key}
 }
 \value{
-An object of class PlotlyClass
+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