ヘルプを取得する

Last updated on 2025-07-22 | Edit this page

Overview

Questions

どこでオンラインの助けを見つけることができますか？
パッケージの開発者や他のユーザーに質問するにはどこに行けばよいですか？
特定のパッケージのドキュメントはどこで見つけることができますか？
複数のパッケージを組み合わせて、一貫したワークフローを学ぶにはどこに行けばよいですか？

Objectives

オンラインリソースを特定する手助けをします。
パッケージのドキュメントにアクセスする。

Bioconductorパッケージに関するヘルプ

Bioconductorパッケージやベストプラクティスに関するヘルプは、いくつかの場所で入手可能です。多くの場合、最良の助けの供給源は状況によって異なります。

特定のタスクに対して最適なパッケージを特定しようとしていますか？
パッケージを初めて使用しようとしていますか？
特定の種類の分析において、複数のパッケージや関数を合理的なワークフローで使用および組み合わせるためのベストプラクティスについて不明な点はありますか？
データに適用したときに関数がエラーを出していますか？
特定のパッケージや関数に実装された理論や方法論について質問がありますか？

次のセクションでは、Bioconductorユーザーが利用できるさまざまなヘルプの供給源と、それぞれが最も有用な状況について説明します。

Bioconductorウェブサイト

メインのBioconductorウェブサイトは、RやBioconductorパッケージをインストールする必要なしに、すべてのリソースを無料で提供します。

特に、biocViewsページは、パッケージのコレクションをテーマに沿って探索し、特定の機能を提供するBioconductorパッケージを特定する素晴らしい方法です。

さらに、ウェブサイトはコースや会議からの資料も収集しており、プレゼンテーション、ビデオ録画、教育資料が含まれています。

自然に、個々のプレゼンテーションやトレーニング資料は、特定のBioconductorパッケージのバージョンに結びついていることがよくあります。そのため、教えられた資料において示されたパッケージのバージョンが、ユーザーのRライブラリのバージョンと一致しているかを確認することが重要です。したがって、使用される教えられた資料において異なるバージョンのパッケージが参照されている場合には、期待される結果と実際の結果の間の不一致を注意深く解釈することが重要です。パッケージのランディングページ

パッケージランディングページ

Bioconductorプロジェクトに受け入れられた各パッケージには、メインのBioconductorウェブサイトにランディングページが与えられます（例：S4Vectors）。

パッケージランディングページには、パッケージ自体をインストールする必要なしに参照できる便利な情報が含まれています。特定のタスクに適したパッケージを探してBioconductorリポジトリを閲覧している場合、これは特に便利です。

ランディングページでは、見込みユーザーがパッケージ機能の短い説明や、パッケージビネットへのリンクを見つけることができます。 Bioconductorウェブサイトで入手可能なパッケージビネットは、開発者によって記述されており、パッケージで利用可能な関数がどのように使用され、完全なワークフローに組み合わされるべきかを示しています。しばしば、ビネットでは、標準的なデータセットが使用され、公開リポジトリから無償で入手可能です（ExperimentDataパッケージやBioconductorのExperimentHub）。

ランディングページの「詳細」セクションでは、多くのパッケージが「BugReports」とラベル付けされたフィールドを提供します。そのフィールドには、ユーザーがパッケージ開発者にバグを報告するために訪れることができるURLが提供されます。

Callout

注意

実際のソフトウェアバグと、パッケージに十分に慣れていないユーザーによる意図しないミスを区別するのが難しいことがあります。このエピソードの後半では、バグを報告するためのアドバイスや、迅速かつ最も有用な返答を受け取るために必要な情報を含める方法を提供します。

疑わしい場合、Bioconductorサポートサイトは、個々の経験やパッケージおよびベストプラクティスに関する知識を共有できる素晴らしい場所でもあります。

さらに、ランディングページでは、パッケージが、ユーザーのシステムでパッケージ自体をインストールして使用できる前にインストールする必要のある他のBioconductorパッケージの数を示すソフトウェアの依存関係から、パッケージがすべてのテストに合格したかどうかを示す日次ビルドレポートまで、多くの重要な情報を提供しています。

Callout

さらに進む

各パッケージには、パッケージがリポジトリに追加されて以来、各Bioconductorのリリースに対してランディングページがあります、例：

パッケージランディングページのURLのバージョン番号は、「release」または「devel」という単語に置き換えることができ、最新の安定版リリースまたは開発版のランディングページにアクセスできます。

パッケージビネット

各Bioconductorパッケージには少なくとも1つのビネットを含めることが求められています。多くのパッケージには1つ以上のビネットがあり、コア機能を特定の使用例から分離しています。

このエピソードの前半で説明したように、ビネットはBioconductorウェブサイトのパッケージランディングページから入手可能です。ただし、ランディングページは、各Bioconductorのバージョンの最も最近のバージョンのパッケージドキュメントにしかリンクされていません。これは、ユーザーのRライブラリにインストールされ、Rセッションで使用されるパッケージのバージョンとは異なる可能性があります。

ユーザーのRライブラリにBioconductorパッケージがインストールされると、そのパッケージの特定のバージョンに関連付けられたビネットもユーザーのコンピュータにインストールされます。それらのローカルにインストールされたビネットは、現在RライブラリにインストールされてRセッションで使用されるパッケージのバージョンのゴールドスタンダードリファレンスです。それらはbrowseVignettes()関数を使用してアクセスできます。例えば：

R

browseVignettes("BiocManager")

具体的には、browseVignettes()関数は、ユーザーのデフォルトのウェブブラウザで開かれ、リクエストされたパッケージに利用可能なすべてのビネットをリストします。各ビネットは3つのフォーマットで提供されます：

コンパイル済みのPDFまたはHTML形式
ソース、SweaveまたはR Markdown形式
Rスクリプトとして

プリコンパイル形式は、ドキュメントの内容を統合されたビューでプレビューできるため、通常は最も快適に読むことができます。これには、プレーンテキストの説明と、コードおよびそれらの出力（図やコンソールメッセージの両方）が含まれます。

パッケージヘルプページ

Bioconductorは、すべてのユーザー向けパッケージ機能がパッケージヘルプページ（通常は「manページ」と呼ばれ、パッケージのサブディレクトリの名前に由来します）で文書化されることを要求します。

help()関数や疑問符シンボル?を使用してヘルプページにアクセスできます。

R

help(topic = "install", package = "BiocManager")
?BiocManager::install

Bioconductorパッケージのヘルプページは、フォーマットや基本的な内容に関して、一般的にCRANパッケージと同じルールに従います。ただし、Bioconductorは、エクスポートされたオブジェクトを文書化するためのほとんどのmanページには、実行可能な例が必要となることも要求します。実行可能な例は、ユーザーが即座に利用可能な小規模データセットに対して、個別の関数の使用を示すのに特に役立ちます - 人工的にシミュレーションされたデータや、公共のデータリポジトリからプログラムでインポートされたデータのいずれかです。

特に、実行可能な例は、理想的なケースで関数の使用を示し、関数への入力がどのようにフォーマットされるべきか、また関数の出力にユーザーがどのような情報を得られるかを示します。これらの例を実行し、例の入力と出力をユーザー自身のデータと比較することで、関数をユーザー自身のデータに適用する前に必要な変換について重要な洞察を提供します。関数の出力がどのように解釈され、相互作用できるかについてもです。

Bioconductorサポートサイト

Bioconductorサポートサイトは、ユーザーと開発者のコミュニティが質問をし、Bioconductorパッケージや分析ワークフローに関する疑問や課題を通じてお互いをサポートするためのプラットフォームを提供します。

サポートサイトは、アカウントなしで自由にブラウズでき、すでに質問され、回答された多くの質問を検索して読むことができます。ただし、新しい質問を投稿するには、プラットフォーム上のアカウントが必要です。プラットフォームへのサインアップは、信頼されているいくつかのプロバイダーからのメールアドレスやオープンオーソリゼーションを使用して簡単に行うことができます。

アップボート制度により、最も人気のある回答が各ページの上部に表示されやすくなります。さらに、オリジナルの投稿者は、自分の問題を解決した回答を1つ選ぶ権利を保持しています。

さらに、回答を提供することでオリジナルの投稿者によって人気または受け入れられたユーザーに付与されたポイント制度は、プラットフォーム上で最も活発で信頼されている貢献者を際立たせます。

Bioconductorサポートサイト。 Bioconductorサポートサイトは、登録ユーザーによって投稿された質問と回答を追跡します。プラットフォームは、未登録のユーザーによって自由にブラウズおよび検索が可能です。

ワークフローパッケージ

Bioconductorワークフローパッケージは、独自の追加コードや機能なしでビネットのみを含むことが期待される点で特別です。代わりに、ワークフローパッケージのビネットは他のパッケージから機能を独占的にインポートし、ユーザーが日常の作業中に直面する可能性のある関数をどのように組み合わせて統合されたワークフローを実現するかを示します。

通常のビネットのように、データは一般に公開されているソースから取得され、BioconductorのExperimentDataパッケージやBioconductorのExperimentHubを含みます。これらの無料で入手可能な標準データセットにより、ユーザーはビネットを読みながら、出力を対話的に再現することができます。

ワークフローパッケージは、biocViewsページの専用セクションで閲覧できます。

Slackワークスペース

Bioconductor Slackワークスペースは、2016年に設立されました。

このHerokuアプリを使用して、個々のメールアドレスの招待を生成することで、自由に参加できます。

Bioconductor Slackワークスペースは、公式発表（例：Bioconductorリリース、会議＆イベント）、および特定のトピックに登録されたユーザーグループ間の非公式な議論、そしてコミュニティメンバー間の直接メッセージのための活発なオンラインプラットフォームです。

このワークスペースには、コミュニティ内の特定のトピックや関心分野に特化した多数のチャネルがあります。これらのチャネルは、活発な研究分野（例：単一細胞ゲノミクス）から、期間限定のイベント（例：会議）、さらには地域社会の Outreach（例：多様性と代表性）まで一般的です。

プライベートチャネルも、ガバナンス（例：イベントの組織、諮問委員会）に存在します。

Callout

注意

Slackワークスペースは、チャネルや直接メッセージを通じて仲間のコミュニティメンバーと迅速な日常的コミュニケーションや議論を行うことを可能にします。

ただし、人気のあるチャネルには、さまざまなタイムゾーンにいる数百人のユーザーが集まる可能性があり、節度と配慮を持って使用する必要があります。対照的に、直接メッセージやプライベートチャネルは、議論に招待されたユーザーに制限され、コミュニティにとって関連する結果は公のチャネルに再投稿する必要があります。

その結果、Bioconductorサポートサイトは、コミュニティにとって興味のある質問を公にするための好ましい方法として残ります。これは、質問、議論、回答が簡単に検索可能であり、主要な検索エンジンによってインデックスされるためです。

ヘルプを効率的に求めるには

コミュニティメンバーのほとんどは、ボランティアとして、自己の余暇の時間で、無報酬で助けを提供しています。したがって、問題の原因を迅速に特定するのを手助けするために、関連情報を提供して、できるだけ明確に質問を行うことが重要です。そうすれば、助ける側と元々の投稿者の両方の時間を節約できます。

質問の内容によっては、いくつかの重要な情報が含まれます：

オペレーティングシステム
Rのバージョン
Bioconductorのバージョン
Rライブラリにインストールされている個別のパッケージのバージョン
現在のセッションにアタッチされている個別のパッケージのバージョン
ユーザーのシステムにインストールされているサードパーティ製ソフトウェア、ライブラリ、およびコンパイラ
Rライブラリにインストールされたパッケージのソース（例：Bioconductor、CRAN、GitHub）
問題に至るまでにRセッションで実行されたコード
セッションで有効なグローバルオプション（options()を使用してアクセス可能）

問題が実行されるコードに関連していて、想定外の出力を生成する場合、他の人がコンピュータ上で問題を再現できるように十分な情報を含めることが重要です。実際、多くの問題には、問題の原因を適切に調査するため、修正をテストするため、または回避策やアドバイスを提供するためには、ライブのRセッションが必要です。

重要なのは、投稿の一部としてコードを提供する際には、読者が実行可能なコードであり、コードによって処理されたデータも含まれていることが重要です。しばしば、コード自体は正しく見えますが、問題はコードと特定のデータセットとの相互作用に関連しています。機密データを共有することができない場合、問題は再計画されて、インターネット上で公開されているデータセットを使用して提示されるか、再現可能な方法でランダムに生成されたシミュレーションデータを生成するためのコードを含む必要があります（例：set.seed()）。

1つの選択肢は、reprexパッケージを使用して、問題を説明するコードおよび出力を整理して、Bioconductorサポートサイトなどの多くのオンラインフォーラムで投稿しやすい形式のテキストにします。

最後に、Bioconductorサポートサイトは、Bioconductorパッケージに関連する質問を投稿するための好ましいプラットフォームです。それは、質問がコミュニティ全体に表示され、定期的にその質問に回答する経験豊富なBioconductorユーザーや、問題に直面するまでにすでに投稿されて解決済みの質問に対する回答を見つけることができる他のユーザーを含むからです。

Key Points

browseVignettes()関数は、各パッケージにインストールされているビネットにアクセスするために推奨されています。
ビネットはBioconductorウェブサイトでもアクセスできますが、パッケージバージョン間の違いには注意してください！
Bioconductorメインウェブサイトには一般情報、パッケージドキュメント、コース資料が含まれています。
Bioconductorサポートサイトは、開発者に連絡し、質問をすべて行うために推奨される場所です。