Project Status: Active – The project has reached a stable, usable state and is being actively developed. Signed by Signed commit %Linux build Status Windows build status Coverage Status cran checks CRAN status Minimal R VersionLicense

Retrieve Magic Attributes from Files and Directories

Description

MIME types are shorthand descriptors for file contents and can be determined from “magic” bytes in file headers, file contents or intuited from file extensions. Tools are provided to perform curated “magic” tests as well as mapping MIME types from a database of over 1,800 extension mappings.

SOME IMPORTANT DETAILS

The header checking is minimal (i.e. nowhere near as comprehensive as libmagic) but covers quite a bit of ground. If there are content-check types from magic sources that you would like coded into the package, please file an issue and include the full line(s) from that linked magic.tab that you would like mapped.

What’s Inside The Tin

  • get_content_type: Discover MIME type of a file based on contents
  • guess_content_type: Guess MIME type from filename (extension)
  • simplemagic_mime_db: File extension-to-MIME mapping data frame

The following functions are implemented:

Installation

install.packages("wand", repos = "https://cinc.rud.is")
# or
remotes::install_git("https://git.rud.is/hrbrmstr/wand.git")
# or
remotes::install_git("https://git.sr.ht/~hrbrmstr/wand")
# or
remotes::install_gitlab("hrbrmstr/wand")
# or
remotes::install_bitbucket("hrbrmstr/wand")
# or
remotes::install_github("hrbrmstr/wand")

NOTE: To use the ‘remotes’ install options you will need to have the {remotes} package installed.

Usage

library(wand)
library(tidyverse)

# current verison
packageVersion("wand")
## [1] '0.6.0'
list.files(system.file("extdat", package="wand"), full.names=TRUE) %>% 
  map_df(~{
    tibble(
      fil = basename(.x),
      mime = list(get_content_type(.x))
    )
  }) %>% 
  unnest()
## # A tibble: 85 x 2
##    fil                     mime                                                             
##    <chr>                   <chr>                                                            
##  1 actions.csv             application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
##  2 actions.txt             application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
##  3 actions.xlsx            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
##  4 test_128_44_jstereo.mp3 audio/mp3                                                        
##  5 test.au                 audio/basic                                                      
##  6 test.bin                application/mac-binary                                           
##  7 test.bin                application/macbinary                                            
##  8 test.bin                application/octet-stream                                         
##  9 test.bin                application/x-binary                                             
## 10 test.bin                application/x-macbinary                                          
## # … with 75 more rows

cloc Metrics

Lang # Files (%) LoC (%) Blank lines (%) # Lines (%)
R 7 0.78 154 0.61 59 0.78 70 0.69
JSON 1 0.11 80 0.32 0 0.00 0 0.00
Rmd 1 0.11 17 0.07 17 0.22 31 0.31

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.