Qiita Teams that are logged in
You are not logged in to any team

Log in to Qiita Team
Community
OrganizationAdvent CalendarQiitadon (β)
Service
Qiita JobsQiita ZineQiita Blog
3
Help us understand the problem. What is going on with this article?
@antiplastics

BiocStyleの紹介

More than 5 years have passed since last update.

R Advent Calendar 2015の第24日目です。

BiocStyleとは

Rでは、

?plot
help(plot)

のようなオブジェクト毎のヘルプページだけでなく、

install.packages("foreach")
library("foreach")
vignette("foreach")

のように、vignette関数で出力されるpdfファイルで、そのパッケージの基本的な使用方法が習得できる場合があります(もちろんパッケージによるが)。
このpdfファイルの事をvignette(ビネットまたは、ビニエット)といいます。

特にバイオインフォマティクスに関するパッケージを公開しているレポジトリBioconductorでは、このvignetteの作成が半ば義務付けられています。

このvignetteは、もともとは、シンプルなフォーマットだったのですが、Bioconductor 2.13から登場した、BiocStyleパッケージによって、より洗練された見た目になりました。

例えば、AnnotationDbiパッケージは、Bioconductor 2.14からBiocStyleを導入しており、Bioconductor 2.13時点のvignetteと比較すると、フォントや、色、レイアウト等で幾つも見やすい工夫がされていることがわかります。

AnnotationDbiのvignette(Bioconductor 2.13、BiocStyle導入前)

2.png

AnnotationDbiのvignette(Bioconductor 2.14、BiocStyle導入後)
1.png

また、vignetteをpdfではなく、htmlで出力する場合もあり、これもBiocstyleの機能です。

paxtoolsrのvignette
1.png

BiocStyleの使い方

vignette自体の作成方法は、biopapyrusのvignetteのページなどを読むと良いです。
実態は.Rnw(Sweaveファイル)がパッケージ内に置かれていて、vignette関数で呼ばれているだけです。

vignetteを更にBiocStyleにしたい場合は、パッケージのDESCRIPTIONファイルに

Suggests: BiocStyle

と記述した後、.Rnwの\documentclass{article}と\begin{document}の間に、

<<style-Sweave, eval=TRUE, echo=FALSE, results=tex>>=
    BiocStyle::latex()
    @

と記述すればいいだけです。

詳細はBiocStyleのvignetteを読みましょう。

3
Help us understand the problem. What is going on with this article?
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
antiplastics
書くぜーどんどん書くぜー(書いてない

Comments

No comments
Sign up for free and join this conversation.
Sign Up
If you already have a Qiita account Login
3
Help us understand the problem. What is going on with this article?