My First Vignette

Ashley Barajas-Sanchez

2018-05-31

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:

Andrew Ryan’s Speech

Andrew Ryan is a character from a video game titled BioShock. He believed that people should not be limited by societal norms and thus created a city for people that were restricted by these norms. This is one of his speeches:

I am Andrew Ryan, and I’m here to ask you a question. Is a man not entitled to the sweat of his brow? ‘No!’ says the man in Washington, ‘It belongs to the poor.’ ‘No!’ says the man in the Vatican, ‘It belongs to God.’ ‘No!’ says the man in Moscow, ‘It belongs to everyone.’ I rejected those answers; instead, I chose something different. I chose the impossible. I chose… Rapture. A city where the artist would not fear the censor. Where the scientist would not be bound by petty morality. Where the great would not be constrained by the small! And with the sweat of your brow, Rapture can become your city as well.

Figures

Here, we have three different types of figures.

dat1 <- iris
plot(iris$Sepal.Length, 
     iris$Petal.Length, 
     xlab="Sepal Length",
     ylab = "Petal Length",
     col=c("#7aa457"))

library(plotly)
#> Loading required package: ggplot2
#> 
#> Attaching package: 'plotly'
#> The following object is masked from 'package:ggplot2':
#> 
#>     last_plot
#> The following object is masked from 'package:stats':
#> 
#>     filter
#> The following object is masked from 'package:graphics':
#> 
#>     layout
library(networkD3)
src <- c("A", "A", "A", "A",
        "B", "B", "C", "C", "D")
target <- c("B", "C", "D", "J",
            "E", "F", "G", "H", "I")
networkData <- data.frame(src, target)
simpleNetwork(networkData)
Here is the map

Here is the map

More Examples

You can write math expressions, like Einstein’s \[E = mc^{2}\].

Also we can use a quote using >:

“If you’re going through hell, keep going.” - Winston Churchill (via),

and tables, e.g. using knitr::kable().

mpg cyl disp hp drat wt qsec vs am gear carb
Mazda RX4 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
Mazda RX4 Wag 21.0 6 160.0 110 3.90 2.875 17.02 0 1 4 4
Datsun 710 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
Hornet 4 Drive 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
Hornet Sportabout 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2
Valiant 18.1 6 225.0 105 2.76 3.460 20.22 1 0 3 1
Duster 360 14.3 8 360.0 245 3.21 3.570 15.84 0 0 3 4
Merc 240D 24.4 4 146.7 62 3.69 3.190 20.00 1 0 4 2
Merc 230 22.8 4 140.8 95 3.92 3.150 22.90 1 0 4 2
Merc 280 19.2 6 167.6 123 3.92 3.440 18.30 1 0 4 4