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:

Vignette Info

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.

Styles

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

Figures

The figure sizes have been customised so that you can easily put two images side-by-side.

plot(1:10)
plot(10:1)

You can enable figure captions by fig_caption: yes in YAML:

output:
  rmarkdown::html_vignette:
    fig_caption: yes

Then you can use the chunk option fig.cap = "Your figure caption." in knitr.

More Examples

You can write math expressions, e.g. $Y = X\beta + \epsilon$, footnotes^[A footnote here.], and tables, e.g. using knitr::kable().

knitr::kable(head(mtcars, 10))

Also a quote using >:

"He who gives up [code] safety for [code] speed deserves neither." (via)

example

some text

# library(heisertransform)
# test<-data.frame(
#         c(.80,.85,.56,.52,.52,.50,.48,.48,.44,.15,.20),
#         c(.19,.12,.22,.23,.24,.25,.26,.27,.28,.63,.06),
#         c(.01,.03,.22,.25,.24,.25,.26,.25,.28,.22,.74)
# )
# names(test)<- c("test1", "test2","test3")
# #tests voor dataset
# test$cat<-c("test1","test1","middel","middel","middel","middel","middel","middel","middel","test2","test3")
# 
# coord<- Heisertransform2Coordinates(test, 1,2,3)
# # coord2<- Heisertransform2Coordinates(test, 1,2,3, T )
# # coord2$cat<-as.factor(coord2$cat)
# vert<- CreateVertices(test, 1,2,3, F)
# plot(vert)
# points(coord)


RMHogervorst/heisertransform documentation built on May 8, 2019, 7:33 a.m.