GitHub引用ジェネレーター
GitHubリポジトリのURLを貼り付けると、ソフトウェアの引用をAPA 7、MLA 9、Chicago 18の形式で、さらにBibTeXとbiblatexのエントリとして得られます。リポジトリにCITATION.cffファイルがあれば読み取り、ZenodoのDOIや、作成者が代わりに引用するよう求めている作品も含めます。ない場合はGitHubのリポジトリ情報を使います。すべての欄は編集できます。無料で、登録は不要です。
ソフトウェアの詳細
このツールは、GitHubのAPIからリポジトリの公開情報を読み取り、CITATION.cffファイルがあればそれも読み取ります。送信されるのはリポジトリのアドレスだけで、送信先はGitHubです。
人名は First Last または Last, First の形式で入力します。The pandas development team のようなグループ名はそのまま残し、それ以外のグループ名は中括弧で囲んでください:{Mozilla}。
開発者が書いたとおり、大文字も含めて入力してください。
引用するバージョンの日付です。日付がない場合は空欄のままにしてください。
リポジトリの場合はGitHub、リリースにDOIがそこで付与されている場合はZenodoなど別のアーカイブ。
引用一覧
GitHubのリポジトリを検索するか、ソフトウェアの名前を入力すると、引用が表示されます。
GitHub引用ジェネレーターの使い方
- 1. リポジトリのアドレスを貼り付けて「検索」を押します。 どの形式でも使えます:https://github.com/owner/repository、その中のファイルへのリンク、または owner/repository だけでも構いません。
- 2. 入力された内容を確認します。 CITATION.cffがあれば、開発者が選んだ作成者、タイトル、バージョン、リリース日、DOIが入力されます。ない場合、GitHubが把握しているのはアカウント名と最新のリリースだけです。プロジェクトが作成者を明記している場合は、実際の作成者を追加してください。
- 3. DOIを残します。 リリースがZenodoなどのリポジトリでアーカイブされている場合、そのDOIは永続的で、どのスタイルもGitHubのアドレスより優先します。
- 4. 引用をコピーします。 CITATION.cffが引用すべき論文を指定している場合、その引用はソフトウェアの引用の後に表示されます。多くのプロジェクトは両方の引用を求めています。
CITATION.cffファイルで得られるもの
CITATION.cffは、リポジトリのルートにある小さなYAMLファイルで、Citation File Format(バージョン1.2.0)の形式でソフトウェアの引用方法を示します。GitHubはこれを読み取り、APAとBibTeXの「このリポジトリを引用」ボタンを表示します。このツールも同じキーを読み取ります:
| CITATION.cffのキー | 内容 | 引用での位置 |
|---|---|---|
authors | 人(family-names、given-names)またはグループ(name) | 作成者の要素 |
title | ソフトウェアの名前 | 斜体のタイトル。大文字は書かれたとおりに残す |
version、date-released | 引用するリリース | バージョンと日付 |
doi、identifiers | DOI(多くはZenodoから) | リンク。URLより優先 |
repository-code | リポジトリのアドレス | DOIがない場合のURL |
preferred-citation | 代わりに引用する論文などの作品 | 2つ目の引用 |
APA、MLA、Chicagoでのソフトウェアの引用
APA 7(§10.10)は、ソフトウェアをタイトルの後にバージョンを括弧で、説明 [Computer software] を付けて引用し、その後に発行元とDOIまたはURLを続けます。APAにはGitHubの例がないため、リリースが別の場所でアーカイブされていない限り、GitHubが発行元になります。MLA 9 は、コア要素からエントリを作成します。ソースコードの引用に関するMLA Style Centerの解説は、リポジトリの所有者を作成者として扱い、ソフトウェアの大文字・小文字をそのまま保ち、バージョンを示し、URLの前にGitHubを2つ目のコンテナとして置くよう述べています。Chicago 18(§14.169)は、ソフトウェアを参考文献で開発者の名前の下に、バージョンと発行元とともに載せます。BibTeXでは、従来の@miscにはバージョンの欄がないため、バージョンはnoteに入ります。biblatexには専用の@softwareの種類があります。
GitHub引用の例
Citation File Formatの仕様そのものです。そのCITATION.cffには9人の作成者、バージョン1.2.0、2021年8月9日のリリース日、そしてZenodoのDOIが記載されています:
APA第7版
参考文献リスト:
Druskat, S., Spaaks, J. H., Chue Hong, N., Haines, R., Baker, J., Bliven, S., Willighagen, E., Pérez-Suárez, D., & Konovalov, O. (2021). Citation File Format (Version 1.2.0) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.5171937
文中引用:
(Druskat et al., 2021)
MLA第9版とChicago第18版
MLA引用文献リスト:
Druskat, Stephan, et al. Citation File Format. Version 1.2.0, Zenodo, 9 Aug. 2021, https://doi.org/10.5281/zenodo.5171937.
Chicago脚注:
Stephan Druskat et al., Citation File Format, version 1.2.0 (Zenodo, 2021), https://doi.org/10.5281/zenodo.5171937.
Chicago参考文献:
Druskat, Stephan, Jurriaan H. Spaaks, Neil Chue Hong, et al. Citation File Format. Version 1.2.0. Zenodo, 2021. https://doi.org/10.5281/zenodo.5171937.
biblatex
@software:
@software{druskat2021citation,
author = {Druskat, Stephan and Spaaks, Jurriaan H. and Chue Hong, Neil and Haines, Robert and Baker, James and Bliven, Spencer and Willighagen, Egon and Pérez-Suárez, David and Konovalov, Olexandr},
title = {{Citation File Format}},
version = {1.2.0},
date = {2021-08-09},
publisher = {Zenodo},
doi = {10.5281/zenodo.5171937},
url = {https://github.com/citation-file-format/citation-file-format}
}MatplotlibのCITATION.cffは、John D. Hunterの2007年の論文も引用するよう求めています。このツールは、その推奨される引用も書式化します:
CITATION.cffの推奨引用
APA 7:
Hunter, J. D. (2007). Matplotlib: A 2D graphics environment. Computing in Science & Engineering, 9(3), 90–95. https://doi.org/10.1109/MCSE.2007.55
BibTeX:
@article{hunter2007matplotlib,
author = {Hunter, John D.},
title = {{Matplotlib: A 2D graphics environment}},
journal = {Computing in Science \& Engineering},
volume = {9},
number = {3},
pages = {90--95},
year = {2007},
doi = {10.1109/MCSE.2007.55}
}CITATION.cffがないリポジトリの場合
CITATION.cffがない場合、ツールはGitHubのリポジトリの公開情報に頼ります。タイトルにはリポジトリの名前、作成者にはオーナーのアカウント、リリースがあればその最新のタグと日付を使います。これは完成した引用ではなく出発点です。作成者はREADMEやプロジェクトのWebサイトで探し、実際に使ったバージョンを引用してください。サインインしない場合、GitHubは1つの接続から1時間に60回のAPIリクエストを許可しており、検索では1、2回使われます。上限に達した場合、ツールはリセットされる時刻を伝えるので、フォームに手で入力することもできます。リポジトリを管理している場合は、CITATION.cffを追加すると、そのすべての引用が一貫します。GitHub以外のプログラムについては、ソフトウェア・コード引用ジェネレーターが扱います。
よくある間違い
- アカウント名を作成者として引用すること。 「numpy」はアカウントであり、作成者はプロジェクトが挙げる人々またはチームです。
- バージョンを省くこと。 コードはリリースごとに変わります。使ったバージョン、リリースのタグ、またはコミットを記載してください。
- DOIがあるのにGitHubのURLを使うこと。 アーカイブされたリリースのDOIは、リポジトリが移動しても壊れません。
- 推奨される引用を無視すること。 開発者が論文の引用を求めている場合は、通常はソフトウェアと並べて、その論文を引用してください。
- ソフトウェア名の大文字を「直す」こと。 pandas、NumPy、scikit-learnは、開発者が書くとおりに表記されます。
よくある質問
- APA 7でGitHubリポジトリを引用するにはどうすればよいですか?
- ソフトウェアとして引用します。作成者、リリースの年、斜体の名前、括弧内のバージョン、[Computer software]、発行元、リンクの順です。アーカイブがなければ発行元はGitHubで、リンクはリポジトリのURLです。ZenodoのDOIがあれば、発行元はZenodoで、リンクはそのDOIです。本文中では (Druskat et al., 2021) の形式になります。
- CITATION.cffファイルとは何ですか?
- リポジトリのルートにある、ソフトウェアの引用方法をCitation File Format形式で示すプレーンテキストのYAMLファイルです。作成者、タイトル、バージョン、リリース日、DOIを記載し、代わりに引用する論文を指定することもできます。GitHubはこれを「このリポジトリを引用」ボタンに変換します。
- ソフトウェアとそれについての論文のどちらを引用すればよいですか?
- CITATION.cffにある開発者の希望に従ってください。論文を求めるものが多く、Citation File Formatのガイドは、ソフトウェアも他の研究成果と同様に評価されるべきだと述べています。そのため両方を引用するのは一般的です。論文は手法のため、ソフトウェアは実際に使ったバージョンのためです。
- GitHubリポジトリのBibTeXエントリはどこで得られますか?
- ここで検索し、エントリをコピーしてください。従来のBibTeXでは@miscを使い、バージョンをnoteに入れます。biblatexでは@softwareを使います。どちらもソフトウェアの名前を二重の中括弧で囲み、大文字が保たれるようにしています。
- 検索にはGitHubのアカウントが必要ですか?
- いいえ。GitHubの公開APIを使い、raw.githubusercontent.comからCITATION.cffファイルを読み取ります。ブラウザから直接行い、送信するのはリポジトリのアドレスだけです。サインインしない場合、GitHubは接続ごとに1時間に60回のAPIリクエストを許可し、検索では1、2回使われます。
- リポジトリが非公開の場合やGitLab上にある場合はどうなりますか?
- 検索は公開されたGitHubリポジトリだけを読み取ります。それ以外の場合は、詳細をフォームに入力してください。引用は同じ形式で整形されます。またはソフトウェア・コード引用ジェネレーターを使ってください。