make_example | R Documentation |
Each package based on a dmdScheme
can contain examples. This function is the interface to these examples.
In the package dmdScheme
, no examples are included.
The function has two basic usages:
by using make_example(schemeName = "NameOfTheScheme")
all included
examples are listed
by using make_example(name = "basic", schemeName = "NameOfTheScheme")
it will create the example named basic
in a
subdirectory in the current working directory. An existing directory with
the same name, will nod be overwritten!
make_example(name)
name |
name of the example |
The examples have to be located in a directory called example_data
.
The function is doing two things:
Copying the complete directory from the example_data
directory
to the current working directory
running knitr::purl
on all ./code/*.Rmd
to extract the code into .R
script files. If you want to include an RMarkdown files in the ./code
directory from thisa, use the .rmd
extension (small letters).
invisibly NULL
make_example() ## Not run: make_example("basic") ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.