R/sortDF.R

In berryFunctions: Function Collection Related to Plotting and Hydrology

#' sort dataframes by column
#' 
#' sort a data.frame by column - basically just a wrapper for order
#' 
#' @return data.frame
#' @author Berry Boessenkool, \email{berry-b@@gmx.de}, June 2015
#' @seealso \code{\link{sort}}, \code{\link{order}}, 
#' \code{\link{insertRows}}, \code{\link{addRows}}
#' @keywords univar manip arith
#' @export
#' @examples
#' sortDF(USArrests[USArrests$Murder>11,], Assault)
#' sortDF(USArrests[USArrests$Murder>11,], "Assault") # safer within functions
#' sortDF(USArrests[USArrests$Murder>11,], 3)
#' 
#' @param df         Data.frame to be sorted
#' @param col        Column (index or (un)quoted name) to be sorted by
#' @param decreasing Logical: should highest value be on top?
#'                   DEFAULT: TRUE (unlike \code{\link{order}}!)
#' @param quiet      Logical: suppress non-df warning? DEFAULT: FALSE
#' @param \dots      Further arguments passed to \code{\link{order}}, 
#'                   like eg \code{na.last or method}
#' 
sortDF <- function(
df,
col,
decreasing=TRUE,
quiet=FALSE,
...
)
{
values <- getColumn(substitute(col),df, quiet=quiet)
df[order(values, decreasing=decreasing, ...),]
}