path.chain

Concise structure for path chaining

https://github.com/krzjoa/path.chain

Repository

Concise structure for path chaining

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# path.chain 


[![CRAN status](https://www.r-pkg.org/badges/version/path.chain)](https://CRAN.R-project.org/package=path.chain)
[![Documentation](https://img.shields.io/badge/documentation-path.chain-orange.svg?colorB=E91E63)](https://krzjoa.github.io/path.chain/)
[![Travis build status](https://travis-ci.org/krzjoa/path.chain.svg?branch=master)](https://travis-ci.org/krzjoa/path.chain)
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/krzjoa/path.chain?branch=master&svg=true)](https://ci.appveyor.com/project/krzjoa/path.chain)
[![Buy hex
stciker](https://img.shields.io/badge/buy%20hex-path.chain-green)](https://www.redbubble.com/i/sticker/path-chain-R-package-hex-sticker-by-krzjoa/45140988.EJUG5?asc=u)


> 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**.

![rstudio](man/figures/path_chain.gif)


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)
```

Owner

GitHub Events

Issues and Pull Requests

Last synced: about 1 year ago

Packages