diff --git a/.gitignore b/.gitignore index 2ae090efac3a351dabbe7a6e5bd8e6d7edf17a4f..d1ba7d903ed2078cc9d211180886e5c60a15edd5 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,5 @@ Rplots.pdf # Emacs temp files \#*\# -.\#* \ No newline at end of file +.\#* +inst/doc diff --git a/DESCRIPTION b/DESCRIPTION index 1180dc1c8ad1be9ae942d3f248302eb89cb6fc49..4fe864fd3768620554ab7ff0afbbc4a5a271d11f 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -9,18 +9,21 @@ Description: legTools is a collection of R functions and datasets used for of them from books. It is maintained by the LEG group (Statistics and Geoinformation Laboratory). Please visit http://www.leg.ufpr.br. Depends: - R (>= 3.2.1) -Imports: - lattice, - latticeExtra -Depends: + R (>= 3.2.1), gWidgets, gWidgetstcltk, knitr, markdown, RWordPress +Imports: + lattice, + latticeExtra License: GPL-3 | file LICENSE URL: http://git.leg.ufpr.br/leg/legTools BugReports: http://git.leg.ufpr.br/leg/legTools/issues LazyData: true Encoding: UTF-8 +Suggests: + knitr, + rmarkdown +VignetteBuilder: knitr diff --git a/buildPkg.R b/buildPkg.R index 8f1fe872da710dd750791d288955a1cfb8c0673a..236e4244534eaed79221359bf04fc606ba19a4ed 100644 --- a/buildPkg.R +++ b/buildPkg.R @@ -45,6 +45,13 @@ build(manual = TRUE, vignettes = FALSE) pkg <- paste0("../legTools_", packageVersion("legTools"), ".tar.gz") install.packages(pkg, repos = NULL) +##---------------------------------------------------------------------- +## Package vignette. +## Based on: http://r-pkgs.had.co.nz/vignettes.html + +use_vignette("PimentelGomes") + + ##====================================================================== ## Sending package tarballs and manual to remote server to be ## downloadable diff --git a/vignettes/PimentelGomes.Rmd b/vignettes/PimentelGomes.Rmd new file mode 100644 index 0000000000000000000000000000000000000000..f99c02b57e8111080980c3a1f503c8c3f4873bf7 --- /dev/null +++ b/vignettes/PimentelGomes.Rmd @@ -0,0 +1,58 @@ +--- +title: "Vignette Title" +author: "Vignette Author" +date: "`r Sys.Date()`" +output: rmarkdown::html_vignette +vignette: > + %\VignetteIndexEntry{Vignette Title} + %\VignetteEngine{knitr::rmarkdown} + %\VignetteEncoding{UTF-8} +--- + +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: + +- Never uses retina figures +- Has a smaller default figure size +- Uses a custom CSS stylesheet instead of the default Twitter Bootstrap style + +## Vignette Info + +Note the various macros within the `vignette` setion 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. + +```{r, fig.show='hold'} +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()`. + +```{r, echo=FALSE, results='asis'} +knitr::kable(head(mtcars, 10)) +``` + +Also a quote using `>`: + +> "He who gives up [code] safety for [code] speed deserves neither." +([via](https://twitter.com/hadleywickham/status/504368538874703872))