-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
118 lines (93 loc) · 3.33 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# path.chain <img src='man/figures/logo.png' align="right" height="139" />
<!-- badges: start -->
[](https://CRAN.R-project.org/package=path.chain)
[](https://krzjoa.github.io/path.chain/)
[](https://travis-ci.org/krzjoa/path.chain)
[](https://ci.appveyor.com/project/krzjoa/path.chain)
[](https://www.redbubble.com/i/sticker/path-chain-R-package-hex-sticker-by-krzjoa/45140988.EJUG5?asc=u)
<!-- badges: end -->
> Concise structure for chainable paths
## Installation
``` r
# install.packages("devtools")
devtools::install_github("krzjoa/path.chain")
```
## Example
If you are using RStudio, you know that among many excellent features of this IDE there is a **path autocompletion**.
However, you can also meet situations, when that may be not enough.
Most of all, I mean bigger projects, where you store a complex file structure in the **config** file.
You can handle such configuration YAML file using the library named [`config`](https://github.com/rstudio/config).
You may encounter a situation, when you'll want to save current directory structure in this config.
### Basic usage
```{r config.yml}
library(magrittr)
library(path.chain)
# Create an example file stucture
tmp <- create_temp_dir("files")
create_sample_dir(tmp, override = TRUE)
# Sample structure we've already created looks as follows
fs::dir_tree(tmp)
# Loading stucture
file.structure <- path_chain(tmp)
file.structure$data$example1.RData
# Loading stucture with naming convention
file.structure <- path_chain(tmp, naming = naming_k)
file.structure$kData$kExample1
# Saving file structure
file.structure %>%
as_config(root.name = "kRoot", wrap = "kDirs") %>% # Required by `{config}` package
yaml::write_yaml(temp_path("config.yaml"))
```
```{yaml}
default:
kDirs:
kRoot: files/
kData:
kRoot: data/
kExample1: kExample1
kExample2: kExample2
kPersons: kPersons
kDocs:
kRoot: docs/
kSchema: kSchema
```
### Loading config file
```{r as_path_chain}
k.dirs <- config::get("kDirs", "default", temp_path("config.yaml")) %>%
as_path_chain()
class(k.dirs)
k.dirs$kData$.
k.dirs$kData$kExample1
```
### Path validation
```{r old.options, echo=FALSE}
old.options <- options()
```
```{r validate}
on_path_not_exists(~ print("Path {.x} not exists"))
is_path_valid <- function(x) if (!grepl("\\.fst", x)) print("Invalid file")
on_validate_path(is_path_valid)
level2.b <- path_link("fileA.RData")
level2.a <- path_link("fileB.fst")
level1 <- path_link("data", list(level2.a = level2.a , level2.b = level2.b))
root <- path_link("files", list(level1))
root$data$level2.a
root$data$level2.b
```
```{r clean, echo=FALSE}
options(old.options)
```