R packageDescription 包装说明

说明

解析并返回‘DESCRIPTION’ 包的文件作为"packageDescription".

实用函数返回(转换)其中的一部分。

用法

packageDescription(pkg, lib.loc = NULL, fields = NULL,
                   drop = TRUE, encoding = "")
packageVersion(pkg, lib.loc = NULL)
packageDate(pkg, lib.loc = NULL,
            date.fields = c("Date", "Packaged", "Date/Publication", "Built"),
            tryFormats = c("%Y-%m-%d", "%Y/%m/%d", "%D", "%m/%d/%y"),
            desc = packageDescription(pkg, lib.loc=lib.loc, fields=date.fields))
asDateBuilt(built)

参数

pkg	带有包名称的字符串。
lib.loc	目录名称的字符向量R Library ，或NULL.默认值为NULL对应于当前已知的所有库。如果使用默认值，则在库之前搜索加载的包和命名空间。
fields	给出要返回的字段标签的字符向量(如果文件中出现其他字段，它们将被忽略)。
drop	如果 TRUE 且 fields 的长度为 1，则返回具有相应字段值的单个字符串，而不是类 "packageDescription" 的对象。
encoding	如果存在Encoding字段，应尝试重新编码为什么编码？如果 NA ，则不重新编码。其他值由 iconv 使用，因此默认的 "" 表示当前区域设置的编码。
date.fields	要尝试的字段标签的字符向量。将返回as.Date(.) 不是NA 的第一个。 (部分实验性，请参阅注释。)
tryFormats	要尝试的日期格式，请参阅as.Date.character()。
desc	可选的，一个名为 list 的组件，其组件由 date.fields 命名；如果默认值很好，也可以指定完整的packageDescription()。
built	对于 asDateBuilt() ，来自 packageDescription(*, fields="Built") 的 character 字符串。

细节

一个包不会是 ‘found’，除非它有一个‘DESCRIPTION' 文件包含一个有效的Version场地。当找不到包目录和有合适的目录但没有有效的‘时，会给出不同的警告DESCRIPTION' 文件。

命名为看起来像包的 attach ed 环境(例如 package:utils2 )将被忽略。

packageVersion() 是一个方便的快捷方式，允许类似 if (packageVersion("MASS") < "7.3") { do.things } 的操作。

对于packageDate()，如果desc有效，则pkg和lib.loc都不被使用。

值

如果一个 'DESCRIPTION' 找到给定包的文件并且可以成功读取，packageDescription返回一个类的对象"packageDescription"，这是一个命名列表，其中(给定)字段的值作为元素，标签作为名称，除非drop = TRUE.

如果解析‘DESCRIPTION' 文件不成功，它返回一个命名列表NAs 以字段标签作为名称 iffields不为空，并且NA否则。

packageVersion() 返回类 "package_version" 的(长度为一)对象。

packageDate() 将从 as.Date() 或 NA 返回 "Date" 对象。

asDateBuilt(built) 返回 "Date" 对象，如果 built 无效，则发出错误信号。

注意

packageDate() 的默认行为(尤其是 date.fields )在某种程度上是实验性的，可能会发生变化。

例子

packageDescription("stats")
packageDescription("stats", fields = c("Package", "Version"))

packageDescription("stats", fields = "Version")
packageDescription("stats", fields = "Version", drop = FALSE)

if(requireNamespace("MASS") && packageVersion("MASS") < "7.3.29")
  message("you need to update 'MASS'")

pu <- packageDate("utils")
str(pu)
stopifnot(identical(pu, packageDate(desc = packageDescription("utils"))),
          identical(pu, packageDate("stats"))) # as "utils" and "stats" are
                                   # both 'base R' and "Built" at same time

也可以看看

read.dcf