fs

lifecycle R build status Coverage status

fs provides a cross-platform, uniform interface to file system operations. It shares the same back-end component as nodejs, the libuv C library, which brings the benefit of extensive real-world use and rigorous cross-platform testing. The name, and some of the interface, is partially inspired by Rust’s fs module.

Installation

You can install the released version of fs from CRAN with:

install.packages("fs")

And the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("r-lib/fs")

Comparison vs base equivalents

fs functions smooth over some of the idiosyncrasies of file handling with base R functions:

Tidy paths

fs functions always return ‘tidy’ paths. Tidy paths

Tidy paths are also coloured (if your terminal supports it) based on the file permissions and file type. This colouring can be customized or extended by setting the LS_COLORS environment variable, in the same output format as GNU dircolors.

Usage

fs functions are divided into four main categories:

Directories and links are special types of files, so file_ functions will generally also work when applied to a directory or link.

library(fs)

# Construct a path to a file with `path()`
path("foo", "bar", letters[1:3], ext = "txt")
#> foo/bar/a.txt foo/bar/b.txt foo/bar/c.txt

# list files in the current directory
dir_ls()
#> DESCRIPTION      LICENSE.md       NAMESPACE        NEWS.md          
#> R                README.Rmd       README.md        _pkgdown.yml     
#> appveyor.yml     codecov.yml      cran-comments.md docs             
#> fs.Rcheck        fs.Rproj         inst             man              
#> man-roxygen      revdep           script.R         src              
#> tests            vignettes

# create a new directory
tmp <- dir_create(file_temp())
tmp
#> /var/folders/dt/r5s12t392tb5sk181j3gs4zw0000gn/T/Rtmp0aiZS3/fileb29d157c3b7c

# create new files in that directory
file_create(path(tmp, "my-file.txt"))
dir_ls(tmp)
#> /var/folders/dt/r5s12t392tb5sk181j3gs4zw0000gn/T/Rtmp0aiZS3/fileb29d157c3b7c/my-file.txt

# remove files from the directory
file_delete(path(tmp, "my-file.txt"))
dir_ls(tmp)
#> character(0)

# remove the directory
dir_delete(tmp)

fs is designed to work well with the pipe, though because it is a minimal-dependency infrastructure package it doesn’t provide the pipe itself. You will need to attach magrittr or similar.

library(magrittr)

paths <- file_temp() %>%
  dir_create() %>%
  path(letters[1:5]) %>%
  file_create()
paths
#> /var/folders/dt/r5s12t392tb5sk181j3gs4zw0000gn/T/Rtmp0aiZS3/fileb29d5be994c3/a
#> /var/folders/dt/r5s12t392tb5sk181j3gs4zw0000gn/T/Rtmp0aiZS3/fileb29d5be994c3/b
#> /var/folders/dt/r5s12t392tb5sk181j3gs4zw0000gn/T/Rtmp0aiZS3/fileb29d5be994c3/c
#> /var/folders/dt/r5s12t392tb5sk181j3gs4zw0000gn/T/Rtmp0aiZS3/fileb29d5be994c3/d
#> /var/folders/dt/r5s12t392tb5sk181j3gs4zw0000gn/T/Rtmp0aiZS3/fileb29d5be994c3/e

paths %>% file_delete()

fs functions also work well in conjunction with other tidyverse packages, like dplyr and purrr.

Some examples…

suppressMessages(
  library(tidyverse))

Filter files by type, permission and size

dir_info("src", recursive = FALSE) %>%
  filter(type == "file", permissions == "u+r", size > "10KB") %>%
  arrange(desc(size)) %>%
  select(path, permissions, size, modification_time)
#> Warning: `recursive` is deprecated, please use `recurse` instead
#> # A tibble: 11 x 4
#>    path                permissions        size modification_time  
#>    <fs::path>          <fs::perms> <fs::bytes> <dttm>             
#>  1 src/RcppExports.o   rw-r--r--        973.5K 2020-01-03 13:49:03
#>  2 src/dir.o           rw-r--r--        535.2K 2020-01-03 13:48:26
#>  3 src/id.o            rw-r--r--        437.7K 2020-01-03 13:48:26
#>  4 src/file.o          rw-r--r--        404.4K 2020-01-03 13:49:03
#>  5 src/fs.so           rwxr-xr-x        398.8K 2020-01-03 13:49:03
#>  6 src/path.o          rw-r--r--        397.1K 2020-01-03 13:48:26
#>  7 src/link.o          rw-r--r--          243K 2020-01-03 13:48:26
#>  8 src/utils.o         rw-r--r--        129.2K 2020-01-03 13:48:26
#>  9 src/error.o         rw-r--r--         19.6K 2020-01-03 13:48:26
#> 10 src/RcppExports.cpp rw-r--r--         12.2K 2020-01-03 13:49:03
#> 11 src/file.cc         rw-r--r--         10.2K 2020-03-03 15:26:28

Tabulate and display folder size.

dir_info("src", recursive = TRUE) %>%
  group_by(directory = path_dir(path)) %>%
  tally(wt = size, sort = TRUE)
#> Warning: `recursive` is deprecated, please use `recurse` instead
#> # A tibble: 54 x 2
#>    directory                           n
#>    <chr>                     <fs::bytes>
#>  1 src/libuv                       3.92M
#>  2 src                              3.5M
#>  3 src/libuv/autom4te.cache        2.44M
#>  4 src/libuv/src/unix               1.2M
#>  5 src/libuv/test                865.35K
#>  6 src/libuv/src/win             683.14K
#>  7 src/libuv/docs/src/static      328.3K
#>  8 src/libuv/m4                  319.95K
#>  9 src/libuv/src                 203.78K
#> 10 src/libuv/include             192.33K
#> # … with 44 more rows

Read a collection of files into one data frame.

dir_ls() returns a named vector, so it can be used directly with purrr::map_df(.id).

# Create separate files for each species
iris %>%
  split(.$Species) %>%
  map(select, -Species) %>%
  iwalk(~ write_tsv(.x, paste0(.y, ".tsv")))

# Show the files
iris_files <- dir_ls(glob = "*.tsv")
iris_files
#> setosa.tsv     versicolor.tsv virginica.tsv

# Read the data into a single table, including the filenames
iris_files %>%
  map_df(read_tsv, .id = "file", col_types = cols(), n_max = 2)
#> # A tibble: 6 x 5
#>   file           Sepal.Length Sepal.Width Petal.Length Petal.Width
#>   <chr>                 <dbl>       <dbl>        <dbl>       <dbl>
#> 1 setosa.tsv              5.1         3.5          1.4         0.2
#> 2 setosa.tsv              4.9         3            1.4         0.2
#> 3 versicolor.tsv          7           3.2          4.7         1.4
#> 4 versicolor.tsv          6.4         3.2          4.5         1.5
#> 5 virginica.tsv           6.3         3.3          6           2.5
#> 6 virginica.tsv           5.8         2.7          5.1         1.9

file_delete(iris_files)

Feedback wanted!

We hope fs is a useful tool for both analysis scripts and packages. Please open GitHub issues for any feature requests or bugs.

In particular, we have found non-ASCII filenames in non-English locales on Windows to be especially tricky to reproduce and handle correctly. Feedback from users who use commonly have this situation is greatly appreciated.