オープンソースプロジェクト
nextgenusfs/funannotate avatar
nextgenusfs/funannotate

funannotate:真菌向け真核生物ゲノム注釈パイプライン

このプロジェクトは「Eukaryotic Genome Annotation Pipeline. Caveats are that GeneMark is not included in the docker image (see licensing below and you can complain to the developers for making it difficult to distribute/use).」を基盤として、実践的に使えるオープンソース実装を提供し、再利用可能なツールチェーンと統合手段を備えています。

スター 400フォーク 95PythonBSD-2-Clause

ひと目でわかる

これは何?
真菌を主対象に、より高等な真核生物にも使えるゲノム注釈パイプライン。Docker、Bioconda、mamba、pipの導入経路がREADMEに示されている。
誰に向いている?
funannotateは、真菌を主対象に、より高等な真核生物にも使えるゲノム注釈パイプライン。Docker、Bioconda、mamba、pipの導入経路がREADMEに示されている。
商用利用できる?
できます。BSD-2-Clause は寛容なライセンスで、著作権表示とライセンス表示を残せば、使用・改変・販売が可能です。
今もメンテナンスされている?
されています。最後のコミットは 6 日前です。
何の言語で書かれている?
主に Python です(GitHub の言語統計による)。

回答はプロジェクトの GitHub データ(最終同期:2026年9月14日)と当サイトの分析に基づくもので、法的助言ではありません。

オープンソース詳細解説

funannotate:READMEが定義する対象と境界

このプロジェクトの中心は「真菌を主対象に、より高等な真核生物にも使えるゲノム注釈パイプライン。Docker、Bioconda、mamba、pipの導入経路がREADMEに示されている。」という説明にある。READMEが明記する範囲では、利用者が最初に確認すべき対象は機能名ではなく、入力、実行環境、生成物の関係である。docker pull nextgenusfs/funannotate、funannotate-docker test -t predict --cpus 12、GENEMARK_PATH、v1.8.17を確認する。 READMEにない性能、互換性、継続運用の保証はここからは読み取れない。

README の最初の実質的な説明は、funannotate がゲノムアノテーションパイプラインであり、真菌向けに作られているが高等真核生物でも動作するというものだ。リポジトリのメタデータはこのプロジェクトを `Eukaryotic Genome Annotation Pipeline` と説明しており、README の位置づけと一致する。README はアノテーションのワークフロー、入力ファイル、出力形式、設定オプションを説明しておらず、インストール、使用方法、詳細情報については http://funannotate.readthedocs.io を参照するよう案内している。つまり、クイックスタートのコマンドは環境構築までを扱い、アノテーション自体のパラメータは扱わない。遺伝子予測や機能アノテーション、結果レポートを知りたい場合は、readthedocs の文書が必要だ。README には最小システム要件や対応 OS の記載もない。

funannotateの確認1では、READMEに記載された固有の入力と出力を対応させる。実行前には環境、依存、権限を確認し、実行後にはログ、生成物、画面表示を保存する。想定と違う場合は、成功扱いにせず、どの記述と結果が食い違ったかを分けて記録する。この作業はnextgenusfs-funannotate-deep-analysisの利用範囲を決めるための具体的な確認であり、別の製品へそのまま置き換えられる説明ではない。 このプロジェクトの中心は「真菌を主対象に、より高等な真核生物にも使えるゲノム注釈パイプライン。Docker、Bioconda、mamba、pipの導入経路がREADMEに示されている。」という説明にある。READMEが明記する範囲では、利用者が最初に確認すべき対象は機能名ではなく、入力、実行環境、生成物の関係である。docker pull nextgenusfs/funannotate、funannotate-docker test -t predict --cpus 12、GENEMARK_PATH、v1.8.17を確認する。 READMEにない性能、互換性、継続運用の保証はここからは読み取れない。

funannotateの確認1では、READMEに記載された固有の入力と出力を対応させる。実行前には環境、依存、権限を確認し、実行後にはログ、生成物、画面表示を保存する。想定と違う場合は、成功扱いにせず、どの記述と結果が食い違ったかを分けて記録する。この作業はnextgenusfs-funannotate-deep-analysisの利用範囲を決めるための具体的な確認であり、別の製品へそのまま置き換えられる説明ではない。

funannotate:入力から出力までの具体的な流れ

利用の入口はプロジェクト固有の構成に沿っている。docker pull nextgenusfs/funannotate、funannotate-docker test -t predict --cpus 12、GENEMARK_PATH、v1.8.17を確認する。 まず小さな入力でコマンドや画面の応答を確認し、標準出力、生成ファイル、HTTP応答、管理画面の表示など、次の工程が受け取るものを分けて記録する。エラー時の挙動や再実行時の状態は、READMEが説明していなければ未確定として扱う。

README は Docker を最も速い開始方法と呼んでいる。`docker pull nextgenusfs/funannotate` は master の最新コードから構築されたイメージを取得するため、タグ付きリリースより先行する。そのイメージには必要なデータベースが含まれ、別のイメージ `nextgenusfs/funannotate-slim` はデータベースなしで funannotate だけを提供する。任意の bash ラッパースクリプト `funannotate-docker` をダウンロードし、実行権限を付けて、funannotate 実行可能ファイルのように使うこともできる。README は例として `funannotate-docker test -t predict --cpus 12` を示している。同じ段落で、GeneMark はライセンスの都合で Docker イメージに含まれていないと警告し、開発者に苦情を伝えるよう書いている。Docker イメージは master 基準なので、安定版とは限らない。

funannotateの確認2では、READMEに記載された固有の入力と出力を対応させる。実行前には環境、依存、権限を確認し、実行後にはログ、生成物、画面表示を保存する。想定と違う場合は、成功扱いにせず、どの記述と結果が食い違ったかを分けて記録する。この作業はnextgenusfs-funannotate-deep-analysisの利用範囲を決めるための具体的な確認であり、別の製品へそのまま置き換えられる説明ではない。 利用の入口はプロジェクト固有の構成に沿っている。docker pull nextgenusfs/funannotate、funannotate-docker test -t predict --cpus 12、GENEMARK_PATH、v1.8.17を確認する。 まず小さな入力でコマンドや画面の応答を確認し、標準出力、生成ファイル、HTTP応答、管理画面の表示など、次の工程が受け取るものを分けて記録する。エラー時の挙動や再実行時の状態は、READMEが説明していなければ未確定として扱う。

funannotateの確認2では、READMEに記載された固有の入力と出力を対応させる。実行前には環境、依存、権限を確認し、実行後にはログ、生成物、画面表示を保存する。想定と違う場合は、成功扱いにせず、どの記述と結果が食い違ったかを分けて記録する。この作業はnextgenusfs-funannotate-deep-analysisの利用範囲を決めるための具体的な確認であり、別の製品へそのまま置き換えられる説明ではない。

funannotate:導入時に触れるファイルとコマンド

導入では依存関係と設定を同時に見る必要がある。docker pull nextgenusfs/funannotate、funannotate-docker test -t predict --cpus 12、GENEMARK_PATH、v1.8.17を確認する。 例えば設定キーやパスを一つだけ置き換えると、実行自体は成功しても接続先、権限、データベース、画像提供元、注釈データベースが変わる可能性がある。実際の環境へ広げる前に、READMEに示された入口が現在のディレクトリとバージョンで動くかを確認する。

conda を使う場合、README は defaults、bioconda、conda-forge のチャンネルを追加し、`conda create -n funannotate "python>=3.6,<3.9" funannotate` で環境を作成するよう指示している。conda の環境解決が遅い場合は、base 環境に mamba をインストールし、`mamba create -n funannotate funannotate` を代替として使うことを勧めている。conda パッケージがどの依存関係を導入するか、GeneMark を自動的にインストールするかは README に書かれていない。pip には二つの経路がある。`python -m pip install funannotate` は公開パッケージを、`python -m pip install git+https://github.com/nextgenusfs/funannotate.git` は master の最新コードをインストールする。README は conda コマンド内のバージョン制約以外に、対応 Python バージョンの範囲を明示していない。

funannotateの確認3では、READMEに記載された固有の入力と出力を対応させる。実行前には環境、依存、権限を確認し、実行後にはログ、生成物、画面表示を保存する。想定と違う場合は、成功扱いにせず、どの記述と結果が食い違ったかを分けて記録する。この作業はnextgenusfs-funannotate-deep-analysisの利用範囲を決めるための具体的な確認であり、別の製品へそのまま置き換えられる説明ではない。 導入では依存関係と設定を同時に見る必要がある。docker pull nextgenusfs/funannotate、funannotate-docker test -t predict --cpus 12、GENEMARK_PATH、v1.8.17を確認する。 例えば設定キーやパスを一つだけ置き換えると、実行自体は成功しても接続先、権限、データベース、画像提供元、注釈データベースが変わる可能性がある。実際の環境へ広げる前に、READMEに示された入口が現在のディレクトリとバージョンで動くかを確認する。

funannotateの確認3では、READMEに記載された固有の入力と出力を対応させる。実行前には環境、依存、権限を確認し、実行後にはログ、生成物、画面表示を保存する。想定と違う場合は、成功扱いにせず、どの記述と結果が食い違ったかを分けて記録する。この作業はnextgenusfs-funannotate-deep-analysisの利用範囲を決めるための具体的な確認であり、別の製品へそのまま置き換えられる説明ではない。

funannotate:運用で見落としやすい制約

READMEの注意点は機能一覧と同じ重さで読むべきである。docker pull nextgenusfs/funannotate、funannotate-docker test -t predict --cpus 12、GENEMARK_PATH、v1.8.17を確認する。 外部APIや第三者リンク、認証情報、ライセンス、手動導入が必要な依存は、単なる設定例ではない。とくにnextgenusfs-funannotate-deep-analysisでは、記載されたものと記載されていないものを分け、未記載の安全性や可用性をプロジェクトの実績として数えない判断が必要になる。

GeneMark は README が手動設定を求めている唯一の外部依存だ。GeneMark-ES/ET を使うには、topaz.gatech.edu/GeneMark/license_download.cgi の開発者指示に従ってインストールする必要がある。README はこのツールをどのインストール経路にも含めていない。続けて二つの調整が必要だとしている。GeneMark 内のすべての Perl スクリプトの shebang 行を `/usr/bin/env perl` に変更し、`gmes_petap.pl` を `$PATH` に追加するか、環境変数 `$GENEMARK_PATH` を gmes_petap ディレクトリに設定する。システムの Perl インタープリタの場所が異なる場合があるためだ。GeneMark のライセンスが具体的に何を制限するか、また GeneMark がないとどの機能が使えないかは README に書かれていない。

funannotateの確認4では、READMEに記載された固有の入力と出力を対応させる。実行前には環境、依存、権限を確認し、実行後にはログ、生成物、画面表示を保存する。想定と違う場合は、成功扱いにせず、どの記述と結果が食い違ったかを分けて記録する。この作業はnextgenusfs-funannotate-deep-analysisの利用範囲を決めるための具体的な確認であり、別の製品へそのまま置き換えられる説明ではない。 READMEの注意点は機能一覧と同じ重さで読むべきである。docker pull nextgenusfs/funannotate、funannotate-docker test -t predict --cpus 12、GENEMARK_PATH、v1.8.17を確認する。 外部APIや第三者リンク、認証情報、ライセンス、手動導入が必要な依存は、単なる設定例ではない。とくにnextgenusfs-funannotate-deep-analysisでは、記載されたものと記載されていないものを分け、未記載の安全性や可用性をプロジェクトの実績として数えない判断が必要になる。

funannotateの確認4では、READMEに記載された固有の入力と出力を対応させる。実行前には環境、依存、権限を確認し、実行後にはログ、生成物、画面表示を保存する。想定と違う場合は、成功扱いにせず、どの記述と結果が食い違ったかを分けて記録する。この作業はnextgenusfs-funannotate-deep-analysisの利用範囲を決めるための具体的な確認であり、別の製品へそのまま置き換えられる説明ではない。

funannotate:採用判断と確認項目

採用候補になるのは、READMEの手順と目的が一致する場合である。docker pull nextgenusfs/funannotate、funannotate-docker test -t predict --cpus 12、GENEMARK_PATH、v1.8.17を確認する。 確認ではプロジェクト名と固有のコマンドまたはパスを残し、入力に対する出力、ログ、権限エラー、再実行結果を照合する。nextgenusfs-funannotate-deep-analysisの用途に必要な部分だけを狭く試し、動いたという一点から本番品質や長期保守まで推測しない。

README の末尾には引用がある。Jonathan M. Palmer と Jason E. Stajich による 2020 年の `Funannotate v1.8.1: Eukaryotic genome annotation` (v1.8)、Zenodo、https://doi.org/10.5281/zenodo.1134477 だ。この引用はバージョン番号 v1.8.1 と Zenodo の記録番号を示している。Docker の段落では、イメージは master の最新コードから構築され、タグ付きリリースより先行すると説明されている。つまり Docker で得たバージョンは Zenodo の引用とは異なる可能性がある。README は現在の安定版番号、変更ログの場所、リリースのタグ付け方法を明記していない。リポジトリのメタデータではデフォルトブランチが master だが、README はブランチ方針を議論していない。

funannotateの確認5では、READMEに記載された固有の入力と出力を対応させる。実行前には環境、依存、権限を確認し、実行後にはログ、生成物、画面表示を保存する。想定と違う場合は、成功扱いにせず、どの記述と結果が食い違ったかを分けて記録する。この作業はnextgenusfs-funannotate-deep-analysisの利用範囲を決めるための具体的な確認であり、別の製品へそのまま置き換えられる説明ではない。 採用候補になるのは、READMEの手順と目的が一致する場合である。docker pull nextgenusfs/funannotate、funannotate-docker test -t predict --cpus 12、GENEMARK_PATH、v1.8.17を確認する。 確認ではプロジェクト名と固有のコマンドまたはパスを残し、入力に対する出力、ログ、権限エラー、再実行結果を照合する。nextgenusfs-funannotate-deep-analysisの用途に必要な部分だけを狭く試し、動いたという一点から本番品質や長期保守まで推測しない。

funannotateの確認5では、READMEに記載された固有の入力と出力を対応させる。実行前には環境、依存、権限を確認し、実行後にはログ、生成物、画面表示を保存する。想定と違う場合は、成功扱いにせず、どの記述と結果が食い違ったかを分けて記録する。この作業はnextgenusfs-funannotate-deep-analysisの利用範囲を決めるための具体的な確認であり、別の製品へそのまま置き換えられる説明ではない。

編集部の結論

funannotateは、真菌を主対象に、より高等な真核生物にも使えるゲノム注釈パイプライン。Docker、Bioconda、mamba、pipの導入経路がREADMEに示されている。という目的があり、docker pull nextgenusfs/funannotate、funannotate-docker test -t predict --cpus 12、GENEMARK_PATH、v1.8.17を確認する。。向いているのはREADMEの前提を管理できる利用者で、説明されていない保証を必要とする用途には向かない。まず固有のコマンドと入力を最小構成で実行し、出力と権限、依存の状態を確認してから範囲を決める。

公式情報源

  1. Official documentation
  2. Official README
  3. Project repository
  4. Release notes
コミュニティノート

コミュニティノート