md2dir: Create hierarchical directories according to (R)...

Description Usage Arguments Value Examples

View source: R/individual.R

Description

Create hierarchical directories according to (R) Markdown-syntax text

Usage

1
2
3
4
5
6
7
md2dir(
  from = NA,
  dir_to = "mindr",
  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

Directories generated.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
output <- file.path(tempdir(), "mindr")
md2dir(c("# a", "## a1", "## a2"), output)
message("Output: ", output)
# unlink(output, recursive = TRUE) # remove the output file

input <- system.file("examples/mindr-md.Rmd", package = "mindr")
input_txt <- readLines(input, encoding = "UTF-8")
output <- file.path(tempdir(), "mindr")
md2dir(from = input_txt, output)
message("Input:  ", input, "\nOutput: ", output)
# file.show(input) # Open the input file unlink(output, recursive = TRUE) #
# remove the output file

md2dir(from = input_txt, output, md_list = TRUE)

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

Related to md2dir in mindr...