roxygenize cranvas

ggobi · Aug 31, 2011 · 4aab385 · 4aab385
1 parent 9024367
commit 4aab385
Show file tree

Hide file tree

Showing 8 changed files with 64 additions and 31 deletions.
diff --git a/R/utils.R b/R/utils.R
@@ -676,7 +676,7 @@ one_pixel = function(painter) {
 ##' @param data the data containing the variables
 ##' @return A character vector
 ##' @author Yihui Xie <\url{http://yihui.name}>
-##' @examples var_names(~., data = mtcars); var_names(1:3, mtcars)
+##' @examples var_names(~., mtcars); var_names(~disp+hp, mtcars); var_names(1:3, mtcars)
 var_names = function(vars, data) {
     UseMethod('var_names')
 }

diff --git a/man/qbar.Rd b/man/qbar.Rd
@@ -97,8 +97,6 @@ qbar(Regional.Code)
 }
 \seealso{
   Other plots: \code{\link{qboxplot}}, \code{\link{qhist}},
-  \code{\link{qmval}}, \code{\link{qmval.default}},
-  \code{\link{qmval.formula}}, \code{\link{qmval.numeric}},
-  \code{\link{qparallel}}, \code{\link{qspine}},
-  \code{\link{qtime}}
+  \code{\link{qmval}}, \code{\link{qparallel}},
+  \code{\link{qspine}}, \code{\link{qtime}}
 }
diff --git a/man/qboxplot.Rd b/man/qboxplot.Rd
@@ -74,8 +74,6 @@ qboxplot(tars1 ~ species, data = qflea)
 }
 \seealso{
   Other plots: \code{\link{qbar}}, \code{\link{qhist}},
-  \code{\link{qmval}}, \code{\link{qmval.default}},
-  \code{\link{qmval.formula}}, \code{\link{qmval.numeric}},
-  \code{\link{qparallel}}, \code{\link{qspine}},
-  \code{\link{qtime}}
+  \code{\link{qmval}}, \code{\link{qparallel}},
+  \code{\link{qspine}}, \code{\link{qtime}}
 }
diff --git a/man/qhist.Rd b/man/qhist.Rd
@@ -119,7 +119,6 @@ qhist(Serve.Speed, freq = FALSE)  # density
 }
 \seealso{
   Other plots: \code{\link{qbar}}, \code{\link{qboxplot}},
-  \code{\link{qmval}}, \code{\link{qmval.default}},
-  \code{\link{qmval.formula}}, \code{\link{qmval.numeric}},
-  \code{\link{qparallel}}, \code{\link{qtime}}
+  \code{\link{qmval}}, \code{\link{qparallel}},
+  \code{\link{qtime}}
 }
diff --git a/man/qmval.Rd b/man/qmval.Rd
@@ -1,27 +1,18 @@
 \name{qmval}
 \alias{qmval}
-\alias{qmval.default}
-\alias{qmval.formula}
-\alias{qmval.numeric}
 \title{Draw a missing value plot}
 \usage{
-qmval(vars, data = last_data(), ...)
-
-\method{qmval}{default}(vars, data = last_data(), horizontal = TRUE, 
+qmval(vars, data = last_data(), horizontal = TRUE, 
     standardize = TRUE, ...)
-
-\method{qmval}{numeric}(vars, data = last_data(), ...)
-
-\method{qmval}{formula}(vars, data = last_data(), ...)
 }
 \arguments{
   \item{vars}{variables to show in the plot: a character
   vector of variable names, or a numeric vector of column
   indices, or a two-sided formula like \code{~ x1 + x2 +
-  x3} (without the left-hand side)}
+  x3} (without the left-hand side); see
+  \code{\link{var_names}}}
 
-  \item{...}{arguments passed to the default method and
-  further to \code{\link{qbar}}}
+  \item{...}{arguments passed to \code{\link{qbar}}}
 
   \item{data}{a mutaframe created by \code{\link{qdata}}
   (default to be \code{\link{last_data}()}, i.e. the lastly

diff --git a/man/qparallel.Rd b/man/qparallel.Rd
@@ -295,7 +295,5 @@ if (require("animation")) {
 \seealso{
   Other plots: \code{\link{qbar}}, \code{\link{qboxplot}},
   \code{\link{qhist}}, \code{\link{qmval}},
-  \code{\link{qmval.default}}, \code{\link{qmval.formula}},
-  \code{\link{qmval.numeric}}, \code{\link{qspine}},
-  \code{\link{qtime}}
+  \code{\link{qspine}}, \code{\link{qtime}}
 }
diff --git a/man/qtime.Rd b/man/qtime.Rd
@@ -127,7 +127,5 @@ link_var(wage) <- NULL  # OFF
 \seealso{
   Other plots: \code{\link{qbar}}, \code{\link{qboxplot}},
   \code{\link{qhist}}, \code{\link{qmval}},
-  \code{\link{qmval.default}}, \code{\link{qmval.formula}},
-  \code{\link{qmval.numeric}}, \code{\link{qparallel}},
-  \code{\link{qspine}}
+  \code{\link{qparallel}}, \code{\link{qspine}}
 }
diff --git a/man/var_names.Rd b/man/var_names.Rd
@@ -0,0 +1,51 @@
+\name{var_names}
+\alias{var_names}
+\alias{var_names.character}
+\alias{var_names.default}
+\alias{var_names.formula}
+\alias{var_names.numeric}
+\title{Get variable names}
+\usage{
+var_names(vars, data)
+
+\method{var_names}{default}(vars, data)
+
+\method{var_names}{character}(vars, data)
+
+\method{var_names}{numeric}(vars, data)
+
+\method{var_names}{formula}(vars, data)
+}
+\arguments{
+  \item{vars}{a character vector of variable names, or a
+  numeric vector of column indices, or a two-sided formula
+  like \code{~ x1 + x2 + x3}}
+
+  \item{data}{the data containing the variables}
+}
+\value{
+  A character vector
+}
+\description{
+  It is often flexible to input variables in plotting
+  functions, and this generic function convert most common
+  inputs (character, numeric or formula) to a character
+  vector of variable names.
+}
+\details{
+  Numeric indices are converted to character names
+  according to the positions of variables in the data;
+  \code{\link[base]{all.vars}} is used to extract all
+  variable names in a formula, and the special formula
+  \code{~ .} is treated differently: it means all variables
+  in the data except thoese names starting with a dot (e.g.
+  \code{.color}).
+}
+\examples{
+var_names(~., mtcars)
+var_names(~disp + hp, mtcars)
+var_names(1:3, mtcars)
+}
+\author{
+  Yihui Xie <\url{http://yihui.name}>
+}