Tiny Vignette formatting issue

[sneumann]

Hi, @schymane pointed out that on
http://bioconductor.org/packages/release/bioc/vignettes/xcms/inst/doc/xcms.html#2_data_import
the formatting is off. The source

xcms/vignettes/xcms.Rmd

Line 66 in 928b049

and mzData format. For the actual data import Bioconductor's SRC\_R[:exports

has For the actual data import Bioconductor’s SRC_R[:exports both]{Biocpkg(“mzR”)} ...
but I never came across that type of formatting / macros. Apart from the fix, I'd love a link
to modern vignette writing :-) Yours, Steffen

[schymane]

@schymane also pointed out that the vignette is great (nice effort) and has been very useful over the last few days, the tiny formatting error is just a mini hitch. ;-)

[jorainer]

Good to hear that somebody actually reads the vignettes 😉
I'll fix it.

Re link to vignette writing: https://rmarkdown.rstudio.com/. They have also cheat sheets: https://www.rstudio.com/resources/cheatsheets/ for quick lookup. And use the nice styles/formatting that comes with BiocStyle package.

If you want some more reading: have also a look at xcms-preprocessing.Rmd in https://github.com/jotsetung/metabolomics2018 - there are some more things not (yet) mentioned in the xcms vignette.

[jorainer]

Fixes are in. Thanks for reporting @schymane

and another nice tutorial for rmarkdown/vignettes: https://kbroman.org/knitr_knutshell/

[jorainer]

Closing because fixes are in (on release and devel versions).