print_skeleton {sketchy}

Print folder structures

Description

print_skeleton prints the folder structure of a research compendium.

Usage

print_skeleton(path = ".", comments = NULL, folders = NULL)

Arguments

path

path to the directory to be printed. Default is current directory.

comments

A character string with the comments to be added to each folder in the graphical representation of the folder skeleton printed on the console.

folders

A character vector including the name of the sub-directories of the project.

Details

The function prints the folder structure of an existing project.

Value

The folder skeleton is printed in the console.

Author(s)

Marcelo Araya-Salas ([e-mail])

References

Araya-Salas, M., Willink, B., Arriaga, A. (2020), sketchy: research compendiums for data analysis in R. R package version 1.0.2.

See Also

compendiums, make_compendium

Examples

{
data(compendiums)

make_compendium(name = "my_other_compendium", path = tempdir(), format = "basic")

print_skeleton(path = file.path(tempdir(), "mycompendium"))
}