Roxygenized with klutometis/roxygen

pzhaonet · Mar 21, 2014 · d525313 · d525313
1 parent 23acfe9
commit d525313
Show file tree

Hide file tree

Showing 25 changed files with 59 additions and 61 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,3 +1,5 @@
+# Generated by roxygen2 (4.0.0): do not edit by hand
+
 export(bye)
 export(info)
 export(install_course_directory)

diff --git a/man/bye.Rd b/man/bye.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{bye}
 \alias{bye}
 \title{Exit swirl.}

diff --git a/man/expr_creates_var.Rd b/man/expr_creates_var.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{expr_creates_var}
 \alias{expr_creates_var}
 \title{Tests if the e$expr creates one new variable (of correct name
@@ -6,8 +7,7 @@ if given.) If so, returns TRUE.}
 expr_creates_var(correctName = NULL)
 }
 \arguments{
-  \item{correctName}{expected name of the new variable or
-  NULL}
+\item{correctName}{expected name of the new variable or NULL}
 }
 \value{
 TRUE or FALSE

diff --git a/man/expr_identical_to.Rd b/man/expr_identical_to.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{expr_identical_to}
 \alias{expr_identical_to}
 \title{Test that the user has entered an expression identical to that
@@ -6,8 +7,7 @@ given as the first argument.}
 expr_identical_to(correct_expression)
 }
 \arguments{
-  \item{correct_expression}{the correct or expected
-  expression as a string}
+\item{correct_expression}{the correct or expected expression as a string}
 }
 \value{
 TRUE or FALSE

diff --git a/man/expr_is_a.Rd b/man/expr_is_a.Rd
@@ -1,11 +1,12 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{expr_is_a}
 \alias{expr_is_a}
 \title{Returns TRUE if e$expr is of the given class}
 \usage{
 expr_is_a(class)
 }
 \arguments{
-  \item{class}{expected class of the given expression}
+\item{class}{expected class of the given expression}
 }
 \value{
 TRUE or FALSE

diff --git a/man/expr_uses_func.Rd b/man/expr_uses_func.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{expr_uses_func}
 \alias{expr_uses_func}
 \title{Returns TRUE if the e$expr uses the function whose
@@ -6,7 +7,7 @@ name is given as the first argument.}
 expr_uses_func(func)
 }
 \arguments{
-  \item{func}{name of the function expected to be used}
+\item{func}{name of the function expected to be used}
 }
 \value{
 TRUE or FALSE

diff --git a/man/func_of_newvar_equals.Rd b/man/func_of_newvar_equals.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{func_of_newvar_equals}
 \alias{func_of_newvar_equals}
 \title{Tests the result of a computation such as mean(newVar) applied
@@ -7,8 +8,7 @@ saved as e$newVar.}
 func_of_newvar_equals(correct_expression)
 }
 \arguments{
-  \item{correct_expression}{expression expected to be
-  applied}
+\item{correct_expression}{expression expected to be applied}
 }
 \value{
 TRUE or FALSE

diff --git a/man/info.Rd b/man/info.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{info}
 \alias{info}
 \title{Display a list of special commands.}

diff --git a/man/install_course_directory.Rd b/man/install_course_directory.Rd
@@ -1,11 +1,12 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{install_course_directory}
 \alias{install_course_directory}
 \title{Install a course from a course directory}
 \usage{
 install_course_directory(path)
 }
 \arguments{
-  \item{path}{The path to the course directory.}
+\item{path}{The path to the course directory.}
 }
 \description{
 Install a course from a course directory

diff --git a/man/install_course_dropbox.Rd b/man/install_course_dropbox.Rd
@@ -1,15 +1,14 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{install_course_dropbox}
 \alias{install_course_dropbox}
 \title{Install a course from a zipped course directory shared on Dropbox}
 \usage{
 install_course_dropbox(url, multi = FALSE)
 }
 \arguments{
-  \item{url}{URL of the shared file}
+\item{url}{URL of the shared file}
 
-  \item{multi}{The user should set to \code{TRUE} if the
-  zipped directory contains multiple courses. The default
-  value is \code{FALSE}.}
+\item{multi}{The user should set to \code{TRUE} if the zipped directory contains multiple courses. The default value is \code{FALSE}.}
 }
 \description{
 Install a course from a zipped course directory shared on Dropbox

diff --git a/man/install_course_github.Rd b/man/install_course_github.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{install_course_github}
 \alias{install_course_github}
 \title{Install a course from a GitHub repository}
@@ -6,18 +7,13 @@ install_course_github(github_username, course_name, branch = "master",
   multi = FALSE)
 }
 \arguments{
-  \item{github_username}{The username that owns the course
-  repository.}
+\item{github_username}{The username that owns the course repository.}
 
-  \item{course_name}{The name of the repository which
-  should be the name of the course.}
+\item{course_name}{The name of the repository which should be the name of the course.}
 
-  \item{branch}{The branch of the repository containing the
-  course. The default branch is \code{"master"}.}
+\item{branch}{The branch of the repository containing the course. The default branch is \code{"master"}.}
 
-  \item{multi}{The user should set to \code{TRUE} if the
-  repository contains multiple courses. The default value
-  is \code{FALSE}.}
+\item{multi}{The user should set to \code{TRUE} if the repository contains multiple courses. The default value is \code{FALSE}.}
 }
 \description{
 Install a course from a GitHub repository

diff --git a/man/install_course_google_drive.Rd b/man/install_course_google_drive.Rd
@@ -1,15 +1,14 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{install_course_google_drive}
 \alias{install_course_google_drive}
 \title{Install a course from a zipped course directory shared on Google Drive}
 \usage{
 install_course_google_drive(url, multi = FALSE)
 }
 \arguments{
-  \item{url}{URL of the shared file}
+\item{url}{URL of the shared file}
 
-  \item{multi}{The user should set to \code{TRUE} if the
-  zipped directory contains multiple courses. The default
-  value is \code{FALSE}.}
+\item{multi}{The user should set to \code{TRUE} if the zipped directory contains multiple courses. The default value is \code{FALSE}.}
 }
 \description{
 Install a course from a zipped course directory shared on Google Drive

diff --git a/man/install_course_url.Rd b/man/install_course_url.Rd
@@ -1,15 +1,14 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{install_course_url}
 \alias{install_course_url}
 \title{Install a course from a url that points to a zip file}
 \usage{
 install_course_url(url, multi = FALSE)
 }
 \arguments{
-  \item{url}{URL that points to a zipped course directory}
+\item{url}{URL that points to a zipped course directory}
 
-  \item{multi}{The user should set to \code{TRUE} if the
-  zipped directory contains multiple courses. The default
-  value is \code{FALSE}.}
+\item{multi}{The user should set to \code{TRUE} if the zipped directory contains multiple courses. The default value is \code{FALSE}.}
 }
 \description{
 Install a course from a url that points to a zip file

diff --git a/man/install_course_zip.Rd b/man/install_course_zip.Rd
@@ -1,15 +1,14 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{install_course_zip}
 \alias{install_course_zip}
 \title{Install a course from a zipped course folder}
 \usage{
 install_course_zip(path, multi = FALSE)
 }
 \arguments{
-  \item{path}{The path to the zipped course.}
+\item{path}{The path to the zipped course.}
 
-  \item{multi}{Set to \code{TRUE} if the zipped directory
-  contains multiple courses. The default value is
-  \code{FALSE}.}
+\item{multi}{Set to \code{TRUE} if the zipped directory contains multiple courses. The default value is \code{FALSE}.}
 }
 \description{
 Install a course from a zipped course folder

diff --git a/man/install_from_swirl.Rd b/man/install_from_swirl.Rd
@@ -1,12 +1,12 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{install_from_swirl}
 \alias{install_from_swirl}
 \title{Install a course from swirl's official list of courses}
 \usage{
 install_from_swirl(course_name)
 }
 \arguments{
-  \item{course_name}{The name of the course you wish to
-  install.}
+\item{course_name}{The name of the course you wish to install.}
 }
 \description{
 Install a course from swirl's official list of courses

diff --git a/man/nxt.Rd b/man/nxt.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{nxt}
 \alias{nxt}
 \title{Begin the upcoming question or unit of instruction.}

diff --git a/man/omnitest.Rd b/man/omnitest.Rd
@@ -1,21 +1,16 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{omnitest}
 \alias{omnitest}
 \title{Test for a correct expression, a correct value, or both.}
 \usage{
 omnitest(correctExpr = NULL, correctVal = NULL, strict = FALSE)
 }
 \arguments{
-  \item{correctExpr}{the correct or expected expression as
-  a string}
+\item{correctExpr}{the correct or expected expression as a string}
 
-  \item{correctVal}{the correct value (numeric or
-  character)}
+\item{correctVal}{the correct value (numeric or character)}
 
-  \item{strict}{a logical value indicating that the
-  expression should be as expected even if the value is
-  correct. If FALSE (the default) a correct value will pass
-  the test even if the expression is not as expected, but a
-  notification will be issued.}
+\item{strict}{a logical value indicating that the expression should be as expected even if the value is correct. If FALSE (the default) a correct value will pass the test even if the expression is not as expected, but a notification will be issued.}
 }
 \description{
 Omnitest can test for a correct expression, a correct value,

diff --git a/man/play.Rd b/man/play.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{play}
 \alias{play}
 \title{Tell swirl to ignore console input for a while.}

diff --git a/man/skip.Rd b/man/skip.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{skip}
 \alias{skip}
 \title{Skip the current unit of instruction.}

diff --git a/man/swirl.Rd b/man/swirl.Rd
@@ -1,15 +1,14 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{swirl}
 \alias{swirl}
 \title{An interactive learning environment for R and statistics.}
 \usage{
 swirl(resume.class = "default", ...)
 }
 \arguments{
-  \item{resume.class}{for development only; please accept
-  the default.}
+\item{resume.class}{for development only; please accept the default.}
 
-  \item{...}{arguments for special purposes only, such as
-  lesson testing}
+\item{...}{arguments for special purposes only, such as lesson testing}
 }
 \description{
 This function presents a choice of course lessons and interactively

diff --git a/man/uninstall_course.Rd b/man/uninstall_course.Rd
@@ -1,11 +1,12 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{uninstall_course}
 \alias{uninstall_course}
 \title{Uninstall a course}
 \usage{
 uninstall_course(course_name)
 }
 \arguments{
-  \item{course_name}{Name of course to be uninstalled}
+\item{course_name}{Name of course to be uninstalled}
 }
 \description{
 Uninstall a course

diff --git a/man/val_has_length.Rd b/man/val_has_length.Rd
@@ -1,12 +1,12 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{val_has_length}
 \alias{val_has_length}
 \title{Test the the length of e$val is that given by the first argument}
 \usage{
 val_has_length(len)
 }
 \arguments{
-  \item{len}{expected length of the variable created by a
-  user}
+\item{len}{expected length of the variable created by a user}
 }
 \value{
 TRUE or FALSE

diff --git a/man/val_matches.Rd b/man/val_matches.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{val_matches}
 \alias{val_matches}
 \title{Returns TRUE if as.character(e$val) matches the regular
@@ -6,8 +7,7 @@ expression given as the first argument.}
 val_matches(regular_expression)
 }
 \arguments{
-  \item{regular_expression}{a regular expression which user
-  value should match}
+\item{regular_expression}{a regular expression which user value should match}
 }
 \value{
 TRUE or FALSE

diff --git a/man/var_is_a.Rd b/man/var_is_a.Rd
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{var_is_a}
 \alias{var_is_a}
 \title{Returns TRUE if a variable of the given name exists
@@ -6,9 +7,9 @@ in the global environment and is of the given class.}
 var_is_a(class, var_name)
 }
 \arguments{
-  \item{class}{expected class which the given variable}
+\item{class}{expected class which the given variable}
 
-  \item{var_name}{name of the variable}
+\item{var_name}{name of the variable}
 }
 \value{
 TRUE or FALSE

diff --git a/man/zip_course.Rd b/man/zip_course.Rd
@@ -1,16 +1,16 @@
+% Generated by roxygen2 (4.0.0): do not edit by hand
 \name{zip_course}
 \alias{zip_course}
 \title{Zip a course directory}
 \usage{
 zip_course(path, dest = NULL)
 }
 \arguments{
-  \item{path}{Path to the course directory to be zipped.}
+\item{path}{Path to the course directory to be zipped.}
 
-  \item{dest}{Path to directory in which the \code{.zip}
-  should be saved. The default value is \code{NULL}, which
-  will cause the \code{.zip} to be created one level above
-  the directory specified in \code{path}.}
+\item{dest}{Path to directory in which the \code{.zip} should be saved. The
+default value is \code{NULL}, which will cause the \code{.zip} to be
+created one level above the directory specified in \code{path}.}
 }
 \description{
 Zip a course directory