nextgenusfs/funannotate:README に基づく導入ガイド
README、メタデータ、ライセンスに基づく nextgenusfs/funannotate の導入と確認ガイドです。
プロジェクトの範囲
nextgenusfs/funannotate の README はプロジェクトを「Eukaryotic Genome Annotation Pipeline」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「README」には次の説明があります。funannotate is a pipeline for genome annotation (built specifically for fungi, but will also work with higher eukaryotes). Installation, usage, and more information can be found at http://funannotate.readthedocs.io。これは範囲の説明であり、本番検証の結果ではありません。
向いている用途
README の「Quickstart Bioconda install:」にある内容から、用途が合うかを先に判断できます。README 没有列出这一项具体能力。。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。README 没有列出这一项具体能力。。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。
動作の考え方
動作の説明は「Quickstart Bioconda install:」など複数の箇所に分かれています。確認できる情報は次の通りです。The pipeline can be installed with conda (via bioconda:。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。
インストールと初回起動
初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 # download/pull the image from docker hub $ docker pull nextgenusfs/funannotate # download bash wrapper script (optional) $ wget -O funannotate-docker https://raw.githubusercontent.com/nextgenusfs/funannotate/master/funannotate-docker # might need to make this executable on your system $ chmod +x /path/to/funannotate-docker # assuming it is in your PATH, now you can run this script as if it were the funannotate executable script $ funannotate-docker test -t predict --cpus 12 実行可能なコマンドがない場合は手順を作らず、「Quickstart Bioconda install:」で依存関係、待受ポート、初回設定を確認します。
設定と日常運用
日常運用は公式文書の範囲に限ります。「Quickstart Bioconda install:」にはIf conda is taking forever to solve the environment, I would recommend giving mamba a try:とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料にはREADME 没有列出这一项具体能力。ともあります。