make_index | R Documentation |
index.md
file to accompany the data
deposit packageGeneric function to create the index.md
file to accompany the data
deposit package
Title
make_index( scheme, path = ".", overwrite = FALSE, template = scheme_path_index_template(), author = NULL, make = c("html", "pdf"), pandoc_bin = "pandoc", pandoc_args = "-s", ... ) ## S3 method for class 'dmdSchemeSet' make_index( scheme, path = ".", overwrite = FALSE, template = scheme_path_index_template(), author = NULL, make = c("pdf", "html"), pandoc_bin = "pandoc", pandoc_args = "-s", ... )
scheme |
a dmdScheme from which the values for the tokens in the
|
path |
path to where the 'index' should be created. The file name of the created index is identical to the file name of the template. |
overwrite |
if TRUE, the target index file will be overwritten automatically, unless the target index is equal to the template, in which case, an error would be raised in all cases. |
template |
template to be used for the index file. For details see the
vignette Create and Customize the index template. The default
template is at |
author |
of the index file |
make |
character vector containing types into which the generated index file should be converted to. default is html and pdf. This function uses pandoc for the conversion!. |
pandoc_bin |
pandoc executable. Needs fully qualified path when not in
|
pandoc_args |
arguments for calling pandoc |
... |
additional arguments for methods |
returns path to the created index.md
file
## Not run: # takes to long for CRAN make_index( dmdScheme_example(), path = tempdir() ) ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.