R/get_file_metadata.R

In KWB-R/kwb.prep: Markdown-Documented Data Preparation

# get_file_metadata ------------------------------------------------------------
#' @importFrom kwb.utils noFactorDataFrame
get_file_metadata <- function(file)
{
  file_info <- file.info(file)

  kwb.utils::noFactorDataFrame(
    file = basename(rownames(file_info)),
    size = format.object_size(file_info$size, units = "auto"),
    modified = file_info$mtime
  )
}

# The following function is a copy of utils:::format.object_size. It has just
# been included here to make all R CMD Checks pass. Do not modify this function.
# Instead, always use the original function.

format.object_size <- function(
  x, units = "b", standard = "auto", digits = 1L, ...
)
{
  known_bases <- c(legacy = 1024, IEC = 1024, SI = 1000)
  known_units <- list(
    SI = c("B", "kB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"),
    IEC = c("B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "ZiB", "YiB"),
    legacy = c("b", "Kb", "Mb", "Gb", "Tb", "Pb"),
    LEGACY = c("B", "KB", "MB", "GB", "TB", "PB")
  )
  units <- match.arg(
    units, c("auto", unique(unlist(known_units), use.names = FALSE))
  )

  standard <- match.arg(standard, c("auto", names(known_bases)))

  if (standard == "auto") {
    standard <- "legacy"
    if (units != "auto") {
      if (endsWith(units, "iB"))
        standard <- "IEC"
      else if (endsWith(units, "b"))
        standard <- "legacy"
      else if (units == "kB")
        stop("For SI units, specify 'standard = \"SI\"'")
    }
  }

  base <- known_bases[[standard]]
  units_map <- known_units[[standard]]
  if (units == "auto") {
    power <- if (x <= 0)
      0L
    else min(as.integer(log(x, base = base)), length(units_map) -
               1L)
  } else {
    power <- match(toupper(units), toupper(units_map)) -
      1L
    if (is.na(power))
      stop(gettextf("Unit \"%s\" is not part of standard \"%s\"",
                    sQuote(units), sQuote(standard)), domain = NA)
  }
  unit <- units_map[power + 1L]
  if (power == 0 && standard == "legacy")
    unit <- "bytes"
  paste(round(x/base^power, digits = digits), unit)
}