Skip to content

Commit 04d4a39

Browse files
authored
add details about vignette index entry (#122)
1 parent f69ecbc commit 04d4a39

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

documentation.Rmd

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,22 @@ output:
6666
6767
```
6868

69+
If you want to write more than one vignette, you may want to control
70+
the order that they are displayed on the package homepage and when the
71+
`browseVignettes()` function is called. Vignettes will show up in
72+
alphabetical order, which may not be a logical ordering without
73+
further specification. One approach to controlling the order of the
74+
vignettes is to use a number in the `VignettteIndexEntry` setting,
75+
e.g. using numbers `1-9`, if you have a single digit number of
76+
vignettes, or `01-99` if you have ten or more vignettes. For example,
77+
the first vignette could specify in the header:
78+
79+
```
80+
vignette: >
81+
%\VignetteEngine{knitr::rmarkdown}
82+
%\VignetteIndexEntry{1. Quick start to MyPackage}
83+
%\VignetteEncoding{UTF-8}
84+
```
6985

7086
Some best practices and requirements for writing _Bioconductor_ vignettes are
7187
detailed in the following sections.

0 commit comments

Comments
 (0)