README.md

S3

R-CMD-check Codecov test
coverage

Overview

A cross-platform interface to file system operations, built on top of the ‘libuv’ C library.

Installation

You can install S3 by using:

install.packages("remotes")
remotes::install_github("tidylab/S3")

Features

| Category | Subcategory | Function | S3 | |:-----------------------|:-----------------------|:-------------------|:----------------------------------------------------------| | File manipulation | File manipulation | file_copy | [v] Implemented | | File manipulation | File manipulation | file_create | [v] Implemented | | File manipulation | File manipulation | file_delete | [v] Implemented | | File manipulation | File manipulation | file_chmod | [-] Not Implemented | | File manipulation | File manipulation | file_chown | [-] Not Implemented | | File manipulation | File manipulation | file_info | [v] Implemented | | File manipulation | File manipulation | file_size | [v] Implemented | | File manipulation | File manipulation | file_move | [v] Implemented | | File manipulation | File manipulation | file_show | [-] Not Implemented | | File manipulation | File manipulation | file_temp | [-] Not Implemented | | File manipulation | File manipulation | file_temp_push | [-] Not Implemented | | File manipulation | File manipulation | file_temp_pop | [-] Not Implemented | | File manipulation | File manipulation | file_touch | [-] Not Implemented | | File manipulation | File manipulation | file_exists | [v] Implemented | | File manipulation | File manipulation | file_access | [-] Not Implemented | | File manipulation | File manipulation | file_exists | [-] Not Implemented | | Directory manipulation | Directory manipulation | dir_copy | [v] Implemented | | Directory manipulation | Directory manipulation | dir_create | [-] Not Implemented | | Directory manipulation | Directory manipulation | dir_copy | [v] Implemented | | Directory manipulation | Directory manipulation | dir_ls | [v] Implemented | | Directory manipulation | Directory manipulation | dir_map | [-] Not Implemented | | Directory manipulation | Directory manipulation | dir_walk | [-] Not Implemented | | Directory manipulation | Directory manipulation | dir_info | [-] Not Implemented | | Directory manipulation | Directory manipulation | dir_tree | [-] Not Implemented | | Directory manipulation | Directory manipulation | dir_exists | [-] Not Implemented | | Link manipulation | Link manipulation | link_exists | [x] Irrelevant | | Link manipulation | Link manipulation | link_copy | [x] Irrelevant | | Link manipulation | Link manipulation | link_create | [x] Irrelevant | | Link manipulation | Link manipulation | link_delete | [x] Irrelevant | | Path manipulation | Path manipulation | path_temp | [-] Not Implemented | | Path manipulation | Path manipulation | path | [v] Implemented | | Path manipulation | Path manipulation | path_wd | [x] Irrelevant | | Path manipulation | Path manipulation | is_absolute_path | [x] Irrelevant | | Path manipulation | Path manipulation | path_expand | [x] Irrelevant | | Path manipulation | Path manipulation | path_expand_r | [x] Irrelevant | | Path manipulation | Path manipulation | path_home | [x] Irrelevant | | Path manipulation | Path manipulation | path_home_r | [x] Irrelevant | | Path manipulation | Path manipulation | path_file | [-] Not Implemented | | Path manipulation | Path manipulation | path_dir | [-] Not Implemented | | Path manipulation | Path manipulation | path_ext | [-] Not Implemented | | Path manipulation | Path manipulation | path_ext_remove | [-] Not Implemented | | Path manipulation | Path manipulation | path_ext_set | [-] Not Implemented | | Path manipulation | Path manipulation | path_filter | [-] Not Implemented | | Path manipulation | Path manipulation | path_real | [-] Not Implemented | | Path manipulation | Path manipulation | path_split | [-] Not Implemented | | Path manipulation | Path manipulation | path_join | [-] Not Implemented | | Path manipulation | Path manipulation | path_abs | [-] Not Implemented | | Path manipulation | Path manipulation | path_norm | [-] Not Implemented | | Path manipulation | Path manipulation | path_rel | [-] Not Implemented | | Path manipulation | Path manipulation | path_common | [-] Not Implemented | | Path manipulation | Path manipulation | path_has_parent | [-] Not Implemented | | Path manipulation | Path manipulation | path_package | [-] Not Implemented | | Path manipulation | Path manipulation | path_sanitize | [-] Not Implemented | | Path manipulation | Path manipulation | path_tidy | [-] Not Implemented | | Helpers | Helpers | is_file | [v] Implemented | | Helpers | Helpers | is_dir | [v] Implemented | | Helpers | Helpers | is_link | [-] Not Implemented | | Helpers | Helpers | is_file_empty | [-] Not Implemented | | Helpers | Helpers | as_fs_path | [-] Not Implemented | | Helpers | Helpers | fs_path | [-] Not Implemented | | Helpers | Helpers | as_fs_bytes | [-] Not Implemented | | Helpers | Helpers | fs_bytes | [-] Not Implemented | | Helpers | Helpers | as_fs_perms | [-] Not Implemented | | Helpers | Helpers | fs_perms | [-] Not Implemented | | System information | System information | group_ids | [-] Not Implemented | | System information | System information | user_ids | [-] Not Implemented |



tidylab/S3 documentation built on June 28, 2022, 11:20 p.m.