Vignettes are long form documentation commonly included in packages. Because they are part of the distribution of the package, they need to be as compact as possible. The html_vignette
output type provides a custom style sheet (and tweaks some options) to ensure that the resulting html is as small as possible. The html_vignette
format:
Note the various macros within the vignette
section of the metadata block above. These are required in order to instruct R how to build the vignette. Note that you should change the title
field and the \VignetteIndexEntry
to match the title of your vignette.
The html_vignette
template includes a basic CSS theme. To override this theme you can specify your own CSS in the document metadata as follows:
output:
rmarkdown::html_vignette:
css: mystyles.css
The figure sizes have been customised so that you can easily put two images side-by-side.
#load( system.file ( 'extdata', 'mydata.rda', package = 'iotables'))
#eurostat_data_example ('create_vocabulary.csv')
#read.csv ( "../inst/extdata/create_vocabulary.csv")
#read.csv ( file.path ( '..', 'inst', 'extdata', 'create_vocabulary.csv'))
#system.file ( 'extdata', 'create_vocabulary.csv', package = 'iotables')
list.files(system.file('extdata', package = 'iotables'))
#> [1] "create_vocabulary.csv"
#> [2] "employment_y_ge15_total_CZ_2015_avg.rds"
#> [3] "employment_y_ge15_total_SK_2017_avg.rds"
#> [4] "lfsq_egan22d.rds"
#> [5] "mydata.rda"
#> [6] "naio_10_cp1620.rds"
#> [7] "naio_10_cp1630.rds"
#> [8] "naio_10_cp1700.rds"
#> [9] "naio_10_product_x_product.rda"
load (system.file('extdata', 'naio_10_product_x_product.rda', package = 'iotables') )