[Bioc-devel] Several vignettes with links between them

[Kevin RUE]

Hi David,

First off, I'd recommend introducing non-crucial changes like this one on
the devel branch (3.9). The devel branch is the developers' primary
playground. If you _really_ think that users can't live without those
vignette updates before the next release, then you can always `git
cherry-pick` (https://git-scm.com/docs/git-cherry-pick) the commits from
the devel branch and apply them to the release branch. Just triple-check
before pushing anything to the Bioconductor Git repository that you're not
introducing any bug (...which is why the release branch it is recommended
to only _fix_ bugs on the release branch).

Then, to answer your questions, I'm sure there are several examples of
packages that use links between their multiple vignettes. Here's my
(biased) suggestion of an example :
https://github.com/csoneson/iSEE/blob/master/vignettes/basic.Rmd#L216
For the result, see:
http://bioconductor.org/packages/release/bioc/vignettes/iSEE/inst/doc/basic.html


Best,
Kevin

On Wed, Nov 14, 2018 at 6:13 AM David Jimenez-Morales <biodavidjm using gmail.com>
wrote:

> Dear all,
>
> I am working on creating several vignettes for my recently released package
> (artMS), instead of having only a long one (as suggested by the bioc
> reviewer). Two questions:
>
>    - Is there a way to link vignettes between themselves? For example, if I
>    have 3 new vignettes, let’s say
>
> vignettes/overviewQuickStart.Rmd
> vignettes/details01.Rmd
> vignettes/details02.Rmd
>
> and I want to add links in overview.Rmd to details01.Rmd and details02.Rmd…
> is this possible?
>
>    - Is ok if I include this improvement in the RELEASE_3_8 branch?
>
> Thanks a lot!
> David
>
>         [[alternative HTML version deleted]]
>
> _______________________________________________
> Bioc-devel using r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/bioc-devel
>

	[[alternative HTML version deleted]]