r2dir: Generate hierarchical directories according to the outline of...

Description Usage Arguments Value Examples

View source: R/wrapper.R

Description

Generate hierarchical directories according to the outline of R code

Usage

1
2
3
4
5
6
7
r2dir(
  from = NA,
  dir_to = NA,
  md_list = FALSE,
  md_bookdown = TRUE,
  dir_quiet = FALSE
)

Arguments

from

Character. The source text of the (R) Markdown syntax text, the R code, the FreeMind mind map code, or the path to the directory.

dir_to

Character. The path of the output directory.

md_list

Logical. whether to process lists like headings in the Markdown input.

md_bookdown

Logical. Whether the R Markdown syntax text is in bookdown style, i.e. # (PART), # (APPENDIX), and # References as an upper level of the Level 1 heading.

dir_quiet

Logical. Whether to display the results of generated directories.

Value

Directory generated.

Examples

1
2
3
4
5
6
7
8
input <- system.file("examples/mindr-r.R", package = "mindr")
input_txt <- readLines(input, encoding = "UTF-8")
output <- file.path(tempdir(), "mindr")
r2dir(input_txt, output)
message("Input:  ", input, "\nOutput: ", output)
# file.show(input) # Open the input file system2('open', output) # Open the
# output dir in explorer.  unlink(output, recursive = TRUE) # remove the output
# file

mindr documentation built on Nov. 22, 2021, 9:07 a.m.

Related to r2dir in mindr...