Description Usage Arguments Details Value See Also Examples
Prepare a module (including mocks, tests and examples) for publication as a modulr gear.
1 | prepare_gear(name = .Last.name, url = NULL, load = TRUE)
|
name |
A string (character vector of lenght one). A module name can contain letters, figures and some special characters,
namely Names containing The name "modulr" corresponds to a special module and is therefore reserved. |
url |
A string (character vector of length one). The URL must use the HTTP(S) protocol. |
load |
A flag. Should an undefined module be implicitely loaded? |
A modulr gear is an R Markdown script containing a module, its
docstring info, and its special modules definitions, like mocks,
tests, and examples, for instance. prepare_gear
prepares such a Modulr
Gear. If an url
is given, the script will be completed accordingly
(see example).
A string (character vector of length one) containing a modulr gear R Markdown script.
define
, release_gear_as_gist
, info
,
and reset
.
1 2 3 4 5 6 7 8 |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.