PR

Rパッケージ：DESCRIPTIONファイルについて

2022.01.16
記事内に広告が含まれています。

Rパッケージを作成するときには必須となるDESCRIPTIONファイルです。

このDESCRIPTIONファイルの役割は、「パッケージの重要なメタデータを保存する」です！

このメタデータとは、新しく作成したパッケージの

  • タイトル
  • 詳細
  • 作成者情報
  • 実行するのに必要な他のパッケージ

等を含みます。

以下にDESCRIPTIONファイルの一例を紹介します。

Figure: DESCRIPTION tab

Package: mypackage
Title: パッケージのタイトル (1行にまとめる)
Version: 0.1 バージョン
Authors＠R: 作成者名(“名前”, “苗字”, email = メール@example.com”, role = c(“aut”, “cre”))
Maintainer: メンテナンス者（多くの場合は作成者ですね）
Description: パッケージの詳細 (1段落にまとめる)
　　　　2行目以降は改行すると4文字分のインデントを空ける
Imports: ←ImportsはDependenciesの中の一つ
　　　　dplyr,
　　　　tidyverse
License: ライセンス

DESCRIPTION各項目の詳細

①Title:

  • タイトルはパッケージについて表した1行の表題です。
  • タイトルケースで表示します。つまり、名詞・動詞・形容詞・代名詞は全て最初の文字は大文字。また、前置詞・接続詞も４文字以上なら大文字）
  • 文末のピリオドは付けない。

②Version：

  • バージョンの数字は少なくとも２数字を使い、ピリオド（.）かハイフン（‐）で区切る
  • 例えば、1.0, 1.9.0

③Author:

  • 作者の情報：名前（”名前”、”苗字”）やメールアドレス等
  • Authors@R: person("first name", "last name", email = "mail address@example.com", role =c("aut", "cre"))
  • roleの、aut:作成者、cre:メンテナンス者（トラブル時に対応する）

④Description：

  • パッケージについての詳細な説明
  • １行を超える場合は、２行目は４文字分のインデントを取る

⑤Licence:

  • ライセンスについてはMIT・GPL-2・GPL-3などがある。
  • ライセンスの詳細についてはchoosealicencse.comを参照してください。

⑥Dependencies:

  • 作成したパッケージを実行するために必要な他のパッケージリスト
  • Importにリストされているパッケージは、作成したパッケージには必ず必要なもので、パッケージインストール時に自動的に一緒にインストールされる。
  • Suggestにリストされているパッケージは必ず必要というわけではないが、あるとBetterなもの

コメント