Maybe "borrow" from the BioC vignettes?

Question

Maybe "borrow" from the BioC vignettes?

eddelbuettel opened this issue 8 years ago · 5 comments

Loving this project -- immediately installed when I saw the CRANberries notice earlier.

One format I have played with is the BioCStyle style which is also more lightweight. Maybe include (with attribution) or borrow from it? Or maybe just refer to it from the documentation as "yet another light(er)weight alternative" ?

Answer 1 · 2016-08-11T19:55:52.000Z

Hi Dirk,

This is great -- I was unware of this template before I wrote prettydoc. I'll contact the authors later to see what is the best way to "borrow" from. Probably including it in prettydoc is more convenient for non-BioC R users.

Another R Markdown template is the tufte package by @yihui. This package can be easily installed from R, so I may refer to it in the documentation in the future version of prettydoc.

Answer 2 · 2016-08-11T20:12:46.000Z

Yes, precisely -- I tend not to go to BioC or update so having it via prettydoc on CRAN would be great to avoid getting it stale.

Answer 3 · 2016-08-15T21:00:21.000Z

According to the discussion in Bioconductor/BiocStyle#10 we probably would better just refer to it.

Answer 4 · 2016-08-15T21:07:05.000Z

Thanks for that. Was unaware of their intent to going full featured. I guess there is room for both.

Worst, once they change, you could resurrect their theme (with attribution, maybe different colours) but it is not a must have. I just wanted to point this out to you -- so thanks for following up. I agree that closing it is the best course of action now.

Answer 5 · 2016-08-15T21:40:16.000Z

I guess one of the major concerns is the identity of Bioconductor, so the preferred way may be to include templates that have noticeably different styles from BiocStyle. 😏