R write_PACKAGES 生成包文件

说明

产生 'PACKAGES', 'PACKAGES.gz' 和 'PACKAGES.rds’源文件或Mac/Windows二进制包的存储库。

用法

write_PACKAGES(dir = ".", fields = NULL,
               type = c("source", "mac.binary", "win.binary"),
               verbose = FALSE, unpacked = FALSE, subdirs = FALSE,
               latestOnly = TRUE, addFiles = FALSE, rds_compress = "xz",
               validate = FALSE)

参数

dir	说明存储库位置(包括源代码或二进制包的目录)的字符向量，用于生成“PACKAGES', 'PACKAGES.gz' 和 'PACKAGES.rds' 文件并将其写入。
fields	给出要在‘中使用的字段的字符向量PACKAGES', 'PACKAGES.gz' 和 'PACKAGES.rds' 除了默认文件之外的文件，或者NULL(默认)。 默认对应于 available.packages : "Package" , "Version" , "Priority" , "Depends" , "Imports" , "LinkingTo" , "Suggests" , "Enhances" , "OS_type" , "License" 和 "Archs" 所需的字段，并且这些字段将始终包含在内，加上字段 "File" 如果 addFile = TRUE 中的文件名，以及字段中子目录的路径"Path" 如果使用子目录。
type	包类型：当前源‘.tar.{gz,bz2,xz}’ 档案，以及 macOS 或 Windows 二进制文件 (‘.tgz' 或者 '。压缩”，分别)支持包。默认为"win.binary"在 Windows 上并"source"否则。
verbose	合乎逻辑的。包是否应在处理过程中列出？
unpacked	指示包内容是否以解包形式提供的逻辑(默认)。
subdirs	逻辑(指示是否应递归地包含子目录)或要包含的子目录名称的字符向量(不递归)。
latestOnly	逻辑：如果一个包有多个版本可用，是否应该只包含最新版本？
addFiles	逻辑：文件名应该作为字段“包含在内”⁠文件⁠' 在里面 'PACKAGES' 文件。
rds_compress	用于‘的压缩类型PACKAGES.rds'： 看saveRDS。默认值是提供最大压缩的值，并且如上所用CRAN.
validate	一个逻辑表明是否‘DESCRIPTION应该验证文件，并跳过相应的包，以防发现问题。

细节

write_PACKAGES扫描 R 包的指定目录，从每个包的‘DESCRIPTION’文件，并将这些信息写入‘PACKAGES', 'PACKAGES.gz' 和 'PACKAGES.rds’文件，其中前两个表示 DCF 格式的信息，第三个通过saveRDS.

仅当软件包的版本要求限制较少时，包含非最新版本的软件包才有用，例如latestOnly = FALSE当‘⁠foo_1.0⁠' 依赖于取决于 '⁠R >= 2.15.0⁠' 但 '⁠foo_0.9⁠' 可用，这取决于 '⁠R >= 2.11.0⁠’。

支持带有子目录的存储库，因此支持subdirs != FALSE取决于记录"Path"字段中的‘PACKAGES’文件。

支持更通用的文件名(例如其他类型的压缩)通过 a "File"字段中的‘PACKAGES’ 文件可以被使用download.packages。如果文件名不是标准格式，请使用addFiles = TRUE.

type = "win.binary"使用unz连接读取所有‘DESCRIPTION’ 给定目录中 Windows(压缩)二进制包中包含的文件dir，并构建文件‘PACKAGES', 'PACKAGES.gz' 和 'PACKAGES.rds’来自此信息的文件。

对于远程存储库，需要在下载速度和 available.packages 处理下载文件所花费的时间之间进行权衡。对于大型存储库，使用 rds_compress = "xz" 可能会有所帮助。

值

无形地返回结果‘中说明的包的数量PACKAGES', 'PACKAGES.gz' 和 'PACKAGES.rds’文件。如果0，没有找到任何包，也没有写入任何文件。

注意

加工 '.tar.gz' 档案来提取 'DESCRIPTION’文件非常慢。

此函数在其他操作系统上很有用，可以准备供 Windows 计算机访问的存储库，因此 type = "win.binary" 应该适用于所有操作系统。

例子

## Not run: 
write_PACKAGES("c:/myFolder/myRepository")  # on Windows
write_PACKAGES("/pub/RWin/bin/windows/contrib/2.9",
               type = "win.binary")  # on Linux

## End(Not run)

作者

Uwe Ligges and R-core.

也可以看看

参看read.dcf和write.dcf用于阅读‘DESCRIPTION” 文件并写入“PACKAGES' 和 'PACKAGES.gz’文件。看update_PACKAGES用于有效更新现有的‘PACKAGES' 和 'PACKAGES.gz’文件。