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