R/file_information.R

Defines functions file_information

Documented in file_information

#' Function to get file information. 
#' 
#' \code{file_infomation} uses \code{file.info} but cleans up the returned data
#' frame a little. 
#' 
#' @author Stuart K. Grange
#' 
#' @param files Vector of file names. 
#' 
#' @return Data frame.
#' 
#' @export
file_information <- function(files) {
  
  # Get information
  df <- file.info(files)
  
  # Tidy a little
  df <- tibble::rownames_to_column(df, "file") %>% 
    mutate(file_basename = basename(file)) %>% 
    select(file,
           file_basename,
           everything())
  
  return(df)
  
}
skgrange/threadr documentation built on May 11, 2024, 12:16 p.m.