Misc. doc tweaks

r-box · Apr 14, 2015 · 2db9fde · 2db9fde
1 parent 54822ae
commit 2db9fde
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 7 deletions.
diff --git a/R/box_save_load.R b/R/box_save_load.R
@@ -1,4 +1,3 @@
-
 #' Save and load \code{R} workspaces via box.com
 #' 
 #' These convenience functions aim to provide analagous functionality to 

diff --git a/R/box_source.R b/R/box_source.R
@@ -1,6 +1,18 @@
-
-#' @rdname box_save
+#' Execute R code stored on box.com
+#' 
+#' \code{box_source} will download a remote R script stored on box.com, and then
+#' attempt to execute it, using \code{\link{source}}.
+#' 
+#' @inheritParams box_dl
+#' 
+#' @author Brendan Rocks \email{rocks.brendan@@gmail.com}
+#' 
 #' @export
+#' 
+#' @seealso \code{\link{box_dl}} for saving files to disk, 
+#'   \code{\link{box_save}} for working with R workspaces, and 
+#'   \code{\link{box_read}} for reading files into memory as R objects.
+#'   
 box_source <- function(file_id){
   temp_dir  <- tempdir()
   temp_file <- box_dl(file_id, overwrite = TRUE, local_dir = temp_dir)

diff --git a/R/boxr__internal_dir_comparison.R b/R/boxr__internal_dir_comparison.R
@@ -125,6 +125,8 @@
 #' 
 #' @references
 #'   \url{https://developers.box.com/docs}
+#'   
+#' @author Brendan Rocks \email{rocks.brendan@@gmail.com}
 #' 
 #' @seealso \code{\link{box_fetch}} and \code{\link{box_push}}, which depend on
 #'   this internal function, \code{\link{file.info}} for timestamps describing

diff --git a/man/box_dir_diff.Rd b/man/box_dir_diff.Rd
@@ -137,6 +137,9 @@ or a download operation? Permitted values are \code{"up"} or \code{"down"}}
     systems.
 }
 }
+\author{
+Brendan Rocks \email{rocks.brendan@gmail.com}
+}
 \references{
 \url{https://developers.box.com/docs}
 }

diff --git a/man/box_save.Rd b/man/box_save.Rd
@@ -1,19 +1,16 @@
 % Generated by roxygen2 (4.1.0): do not edit by hand
-% Please edit documentation in R/box_save_load.R, R/box_source.R
+% Please edit documentation in R/box_save_load.R
 \name{box_save}
 \alias{box_load}
 \alias{box_save}
 \alias{box_save_image}
-\alias{box_source}
 \title{Save and load \code{R} workspaces via box.com}
 \usage{
 box_save(..., dir_id = box_getwd(), file_name = ".RData")
 
 box_save_image(dir_id = box_getwd(), file_name = ".RData", ...)
 
 box_load(file_id)
-
-box_source(file_id)
 }
 \arguments{
 \item{...}{The objects to be saved. Quoted or unquoted. Passed to

diff --git a/man/box_source.Rd b/man/box_source.Rd
@@ -0,0 +1,24 @@
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/box_source.R
+\name{box_source}
+\alias{box_source}
+\title{Execute R code stored on box.com}
+\usage{
+box_source(file_id)
+}
+\arguments{
+\item{file_id}{The box.com id for the file that you'd like to download}
+}
+\description{
+\code{box_source} will download a remote R script stored on box.com, and then
+attempt to execute it, using \code{\link{source}}.
+}
+\author{
+Brendan Rocks \email{rocks.brendan@gmail.com}
+}
+\seealso{
+\code{\link{box_dl}} for saving files to disk,
+  \code{\link{box_save}} for working with R workspaces, and
+  \code{\link{box_read}} for reading files into memory as R objects.
+}
+