diff --git a/R/data_arrange.R b/R/data_arrange.R index e84314d4c..647dbe777 100644 --- a/R/data_arrange.R +++ b/R/data_arrange.R @@ -9,10 +9,12 @@ #' data frame. #' @param select Character vector of column names. Use a dash just before column #' name to arrange in decreasing order, for example `"-x1"`. +#' @param by Optional character string, indicating the names of one or more +#' variables in the data frame. If supplied, data rows will be sorted within +#' each group. #' @param safe Do not throw an error if one of the variables specified doesn't #' exist. #' @param ... Currently not used. -#' @inheritParams data_summary #' #' @return A data frame, where rows are sorted according to the selected columns. #' diff --git a/man/data_arrange.Rd b/man/data_arrange.Rd index fc54ed29b..1f7e31aaf 100644 --- a/man/data_arrange.Rd +++ b/man/data_arrange.Rd @@ -19,8 +19,8 @@ data frame.} name to arrange in decreasing order, for example \code{"-x1"}.} \item{by}{Optional character string, indicating the names of one or more -variables in the data frame. If supplied, the data will be split by these -variables and summary statistics will be computed for each group.} +variables in the data frame. If supplied, data rows will be sorted within +each group.} \item{safe}{Do not throw an error if one of the variables specified doesn't exist.}