automatic vignette build

theislab · Jan 25, 2018 · 3b99884 · 3b99884
1 parent f812733
commit 3b99884
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -10,8 +10,10 @@ Authors@R: c(
 Maintainer: Maren Büttner <maren.buettner@helmholtz-muenchen.de>
 Description: This tool detects batch effects in high-dimensional data based on chi^2-test.
 Imports: FNN, RColorBrewer, ggplot2, cluster, stats, grDevices, utils, MASS
+Suggests: knitr
 License: GPL 
 Encoding: UTF-8
+VignetteBuilder: knitr
 LazyData: true
 RoxygenNote: 6.0.1
 biocViews: CellBiology, CellBasedAssays, BatchEffect, Software

diff --git a/kBET.Rproj b/kBET.Rproj
@@ -18,3 +18,4 @@ StripTrailingWhitespace: Yes
 BuildType: Package
 PackageUseDevtools: Yes
 PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,vignette
diff --git a/vignettes/kBET_vignette.Rmd b/vignettes/kBET_vignette.Rmd
@@ -1,4 +1,3 @@
-%\VignetteEncoding{UTF-8}
 ---
 title: "The kBET user's guide"
 author: "Maren Büttner"
@@ -7,6 +6,10 @@ output:
   prettydoc::html_pretty:
     theme: cayman
     highlight: vignette
+vignette: >
+  %\VignetteEncoding{UTF-8}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteIndexEntry{"The kBET user's guide"}
 bibliography: reference.bib
 ---