Hi Zuguang,
On 23/09/2021 05:45, Zuguang Gu wrote:
Hi Giulia,
I think it is ok to host the vignettes somewhere else. I have two packages
of which the vignettes are hosted on GitHub Page.
Unfortunately this is something we **strongly** discourage.
It's important to understand that your vignettes can break any time
(e.g. when something they depend on changes), not just when you update
your package. This is why Bioconductor vignettes should always be
located in the vignettes/ folder of the package, and be "real"
vignettes, that is, they must contain code chunks that get evaluated by
'R CMD check'.
Best,
H.
http://www.bioconductor.org/packages/devel/bioc/html/ComplexHeatmap.html
https://www.bioconductor.org/packages/devel/bioc/html/cola.html
But since now the vignettes are not automatically checked, you need to make
sure every time you update your package, the vignettes can be successfully
generated.
Cheers,
Zuguang
On Thu, 23 Sept 2021 at 14:07, Giulia Pais <giuliapa...@gmail.com> wrote:
Hello, I’m the developer of the package ISAnalytics.
I’d like to ask if it is possible to have a file/vignette that links to
other documentation outside the package (like a GitHub wiki) since we have
issues with the maximum allowed package size due to vignette size, We would
like to maintain as much documentation as possible and we already tried to
reduce data included but it’s not sufficient.
Thanks in advance
Giulia Pais
[[alternative HTML version deleted]]
_______________________________________________
Bioc-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/bioc-devel
[[alternative HTML version deleted]]
_______________________________________________
Bioc-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/bioc-devel
--
Hervé Pagès
Bioconductor Core Team
hpages.on.git...@gmail.com
_______________________________________________
Bioc-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/bioc-devel
