R/rownames.R

In strboul/mmy: Custom miscellaneous R functions

#' Dealing with rownames
#'
#' @param x data.frame.
#'
#' @details
#' \enumerate{
#' \item \code{un_row_names} removes the row names of a data.frame.
#' \item \code{std_row_names} standardizes row names. In other words, it removes them
#' and attaches as a new column into a new \code{data.frame}.
#' }
#' @examples
#' un_rownames(mtcars)
#' std_rownames(mtcars)
#' @name rownames
NULL

#' @rdname rownames
#' @export
un_rownames <- function(x) {
  rownames(x) <- NULL
  x
}

#' @param rowname the column name for the rownames. Default value is \code{.rowname}.
#' @rdname rownames
#' @export
std_rownames <- function(x, rowname = NULL) {
  r.names <- suppressWarnings(as.integer(rownames(x)))
  if (identical(r.names, seq(1L, nrow(x)))) {
    return(x)
  }
  rowname.column.name <- if (is.null(rowname)) ".rowname" else as.character(rowname)
  x[[rowname.column.name]] <- row.names(x)
  x <- x[c(rowname.column.name, setdiff(names(x), rowname.column.name))]
  un_rownames(x)
}