New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tiny Vignette formatting issue #327

Open
sneumann opened this Issue Nov 14, 2018 · 3 comments

Comments

Projects
None yet
3 participants
@sneumann
Owner

sneumann commented Nov 14, 2018

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

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

This comment has been minimized.

schymane commented Nov 14, 2018

@jotsetung jotsetung self-assigned this Nov 14, 2018

@jotsetung

This comment has been minimized.

Collaborator

jotsetung commented Nov 14, 2018

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.

jotsetung added a commit that referenced this issue Nov 14, 2018

@jotsetung

This comment has been minimized.

Collaborator

jotsetung commented Nov 14, 2018

Fixes are in. Thanks for reporting @schymane

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment