Change newJSON back to createJSON

taalbrecht · Nov 26, 2014 · 81be601 · 81be601
1 parent 233f4bf
commit 81be601
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 23 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,5 +1,5 @@
 # Generated by roxygen2 (4.0.2): do not edit by hand
 
-export(newJSON)
+export(createJSON)
 export(runShiny)
 export(serVis)
diff --git a/R/newjson.R → R/createJSON.R b/R/newjson.R → R/createJSON.R
@@ -1,7 +1,7 @@
 #' Create the JSON object to read into the javascript visualization
 #' 
 #' This function creates the JSON object that feeds the visualization template.
-#' For a more detailed overview, see \code{vi}
+#' For a more detailed overview, see \code{vignette("details", package = "LDAvis")}
 #' 
 #' @param phi matrix, with each row containing the distribution over terms 
 #' for a topic, with as many rows as there are topics in the model, and as 
@@ -64,7 +64,7 @@
 #' data(AP, package="LDAvis")
 #'
 #' # create the json object:
-#' json <- newJSON(phi = AP$phi, theta = AP$theta, alpha = AP$alpha, 
+#' json <- createJSON(phi = AP$phi, theta = AP$theta, alpha = AP$alpha, 
 #'                beta = AP$beta, doc.length = AP$doc.length, 
 #'                vocab = AP$vocab, term.frequency = AP$term.frequency, 
 #'                R = 30, print.progress = TRUE)
@@ -84,7 +84,7 @@
 #' serVis(json, as.gist = TRUE)
 #'}
 
-newJSON <- function(phi = matrix(), theta = matrix(), alpha = numeric(), 
+createJSON <- function(phi = matrix(), theta = matrix(), alpha = numeric(), 
                     beta = numeric(), doc.length = integer(), 
                     vocab = character(), term.frequency = integer(), R = 30, 
                     quiet = FALSE) {

diff --git a/R/serVis.R b/R/serVis.R
@@ -1,10 +1,12 @@
-#' Serve the javascript version of LDAvis
+#' View/share LDAvis
 #' 
-#' This function will place the necessary html/js/css files (located in 
-#' system.file("html", package = "LDAvis"))
-#' in a directory specified by the argument out.dir. Then, if appropriate, 
+#' Then, if appropriate, 
 #' the function will prompt your browser to serve the visualization.
 #' 
+#' @details This function will place the necessary html/js/css files (located in 
+#' \code{system.file("htmljs", package = "LDAvis")}) in a directory specified 
+#' by the argument \code{out.dir}.
+#' 
 #' @param json character string output from the \link{createjson} function.
 #'
 #' @param out.dir directory to store html/js/json files.
@@ -17,11 +19,11 @@
 #' @param as.gist should the vis be uploaded as a gist? If so, make sure your 
 #' 'github.username' and 'github.password' are set in \link{options}.
 #'
-#' @param ... arguments passed onto gistr::gist_create if as.gist is TRUE
+#' @param ... arguments passed onto \code{gistr::gist_create}
 #'
 #' @return An invisible object.
 #' 
-#' @seealso \link{newJSON}
+#' @seealso \link{createJSON}
 #' @export
 #' @author Carson Sievert
 #' 

diff --git a/man/newJSON.Rd → man/createJSON.Rd b/man/newJSON.Rd → man/createJSON.Rd
@@ -1,9 +1,9 @@
 % Generated by roxygen2 (4.0.2): do not edit by hand
-\name{newJSON}
-\alias{newJSON}
+\name{createJSON}
+\alias{createJSON}
 \title{Create the JSON object to read into the javascript visualization}
 \usage{
-newJSON(phi = matrix(), theta = matrix(), alpha = numeric(),
+createJSON(phi = matrix(), theta = matrix(), alpha = numeric(),
   beta = numeric(), doc.length = integer(), vocab = character(),
   term.frequency = integer(), R = 30, quiet = FALSE)
 }
@@ -52,7 +52,7 @@ file or feed into \link{serVis} for easy viewing/sharing.
 \description{
 This function creates the JSON object that feeds the
 visualization template. For a more detailed overview, see
-\code{vi}
+\code{vignette("details", package = "LDAvis")}
 }
 \details{
 The function first computes the topic frequencies (across
@@ -73,7 +73,7 @@ If \code{print.progress = TRUE} progress in this loop
 data(AP, package="LDAvis")
 
 # create the json object:
-json <- newJSON(phi = AP$phi, theta = AP$theta, alpha = AP$alpha,
+json <- createJSON(phi = AP$phi, theta = AP$theta, alpha = AP$alpha,
                beta = AP$beta, doc.length = AP$doc.length,
                vocab = AP$vocab, term.frequency = AP$term.frequency,
                R = 30, print.progress = TRUE)

diff --git a/man/serVis.Rd b/man/serVis.Rd
@@ -1,7 +1,7 @@
 % Generated by roxygen2 (4.0.2): do not edit by hand
 \name{serVis}
 \alias{serVis}
-\title{Serve the javascript version of LDAvis}
+\title{View/share LDAvis}
 \usage{
 serVis(json, out.dir = tempfile(), open.browser = interactive(),
   as.gist = FALSE, ...)
@@ -22,18 +22,21 @@ serVis(json, out.dir = tempfile(), open.browser = interactive(),
   so, make sure your 'github.username' and
   'github.password' are set in \link{options}.}
 
-  \item{...}{arguments passed onto gistr::gist_create if
-  as.gist is TRUE}
+  \item{...}{arguments passed onto
+  \code{gistr::gist_create}}
 }
 \value{
 An invisible object.
 }
 \description{
+Then, if appropriate, the function will prompt your browser
+to serve the visualization.
+}
+\details{
 This function will place the necessary html/js/css files
-(located in system.file("html", package = "LDAvis")) in a
-directory specified by the argument out.dir. Then, if
-appropriate, the function will prompt your browser to serve
-the visualization.
+(located in \code{system.file("htmljs", package =
+"LDAvis")}) in a directory specified by the argument
+\code{out.dir}.
 }
 \examples{
 \dontrun{
@@ -44,6 +47,6 @@ help(createJSON, package = "LDAvis")
 Carson Sievert
 }
 \seealso{
-\link{newJSON}
+\link{createJSON}
 }