juicedown (version 0.1.1)

juicedown_example: List example files

Description

List example files for the package. Show the path when the exact name is given.

Usage

juicedown_example(name = NULL, file = NULL)

Value

character. A list of example files or a path string to each example file.

Arguments

name

character. A single string for example name.

file

character. A single string for the main file.

Details

The package sample files are organized under samples directory like so:

samples/ |-- from-html/ | -- sample.html -- include/ |-- pic/ `-- sample.Rmd

• juicedown_example() is equivalent to ls samples,

• juicedown_example("from-html") is to ls samples/from-html, and

• juicedown_example("from-html", "sample.html") shows the full path.

Examples

juicedown_example()
juicedown_example("from-html")
juicedown_example("from-html", "sample.html")