mindr (version 1.2.3)

dir2: Convert a folder structure into a mindmap by using the 'tree' command.

Description

Convert a folder structure into a mindmap by using the 'tree' command.

Usage

dir2(
  path = getwd(),
  savefile = TRUE,
  savefilename = "mindr.mm",
  output = c("mm", "txt", "md", "Rmd"),
  backup = TRUE,
  dir_files = FALSE
)

Arguments

path

character. the path of the folder.

savefile

logical. Whether to save the output as a file.

savefilename

character. Valid when savefile == TRUE.

output

a file with the folder structure.

backup

logical. Whether the existing target file, if any, should be saved as backup.

dir_files

logical. Whether to display files besides folders.

Value

a mindmap file, which can be viewed by common mindmap software, such as 'FreeMind' (http://freemind.sourceforge.net/wiki/index.php/Main_Page) and 'XMind' (http://www.xmind.net).

Details

For LinUx OS and mac OS, the 'tree' command must be pre-installed.

• Linux: sudo apt-get install tree

• mac: install Homebrew first. Then in the terminal: brew install tree.