Merge pull request hadley#205 from krlmlr/124-rowwise-docs

add docs to show how to apply a function rowwise

R/d_ply.r

@@ -1,6 +1,8 @@
 #' Split data frame, apply function, and discard results.
 #'
-#' For each subset of a data frame, apply function and discard results
+#' For each subset of a data frame, apply function and discard results.
+#' To apply a function for each row, use \code{\link{a_ply}} with
+#' \code{.margins} set to \code{1}.
 #'
 #' @template ply
 #' @template d-

R/daply.r

@@ -3,6 +3,8 @@
 #' For each subset of data frame, apply function then combine results into
 #' an array.  \code{daply} with a function that operates column-wise is
 #' similar to \code{\link{aggregate}}.
+#' To apply a function for each row, use \code{\link{aaply}} with
+#' \code{.margins} set to \code{1}.
 #'
 #' @template ply
 #' @section Input: This function splits data frames by variables.

R/ddply.r

@@ -2,6 +2,8 @@
 #'
 #' For each subset of a data frame, apply function then combine results into a
 #' data frame.
+#' To apply a function for each row, use \code{\link{adply}} with
+#' \code{.margins} set to \code{1}.
 #'
 #' @template ply
 #' @template d-

R/dlply.r

@@ -3,6 +3,8 @@
 #' For each subset of a data frame, apply function then combine results into a
 #' list. \code{dlply} is similar to \code{\link{by}} except that the results
 #' are returned in a different format.
+#' To apply a function for each row, use \code{\link{alply}} with
+#' \code{.margins} set to \code{1}.
 #'
 #' @template ply
 #' @template d-

man/d_ply.Rd

@@ -44,7 +44,9 @@ environment set up for computing.}
 Nothing
 }
 \description{
-For each subset of a data frame, apply function and discard results
+For each subset of a data frame, apply function and discard results.
+To apply a function for each row, use \code{\link{a_ply}} with
+\code{.margins} set to \code{1}.
 }
 \section{Input}{
  This function splits data frames by variables.

man/daply.Rd

@@ -50,6 +50,8 @@ if results are atomic with same type and dimensionality, a
 For each subset of data frame, apply function then combine results into
 an array.  \code{daply} with a function that operates column-wise is
 similar to \code{\link{aggregate}}.
+To apply a function for each row, use \code{\link{aaply}} with
+\code{.margins} set to \code{1}.
 }
 \section{Input}{
  This function splits data frames by variables.

man/ddply.Rd

@@ -43,6 +43,8 @@ A data frame, as described in the output section.
 \description{
 For each subset of a data frame, apply function then combine results into a
 data frame.
+To apply a function for each row, use \code{\link{adply}} with
+\code{.margins} set to \code{1}.
 }
 \section{Input}{
  This function splits data frames by variables.

man/dlply.Rd

@@ -44,6 +44,8 @@ list of results
 For each subset of a data frame, apply function then combine results into a
 list. \code{dlply} is similar to \code{\link{by}} except that the results
 are returned in a different format.
+To apply a function for each row, use \code{\link{alply}} with
+\code{.margins} set to \code{1}.
 }
 \section{Input}{
  This function splits data frames by variables.