roxygen2 + cygwin + 默认参数 = 截断的 `\usage` 部分

Question

我有一个 R 包，我一直在 Linux 下开发，我在 Windows 下测试它的可怕时刻已经到来。

文档是用roxygen做的，我是用cygwin来构建包的。

问题是，当我 roxygenise('test-package') 时，roxygen 会将文档的 \usage 部分截断为一个字符。它对我的一些但不是所有功能都这样做，我无法弄清楚这种模式。

在 Linux 或 Windows 下运行相同的命令（即 R 提示符下的 roxygenise('test-package')）时不会发生这种情况 - 只是 Windows 下的 Cygwin（使用 R devtools + Windows 中的命令提示符对我来说不是一个选项 - 它是一部分一个大项目的 Makefile 等）。

在所有情况下，我都使用 roxygen v2.2.2。

---

更新：

这似乎发生在任何带有默认参数的函数上。

---

我已将其归结为一个可重现的示例，并尽可能精简以隔离问题：

1. 来自 R：

   # this function used to trim strings, but I've stripped it right down
   # to eliminate it as a cause of the problem
   trim <- function(x='asdf')
   {
       return( x )
   }
   package.skeleton('test')
   

2. 修改 trim.R（在 test/R 中）并将以下 roxygen 添加到顶部，因此文件如下所示：

   #' trim white spaces from a string
   #'
   #' @param x string or vector of strings to trim
   #' @return x trimmed.
   #' @export
   trim <-
   function(x='asdf')
   {
       return( x )
   }
   

3. 运行 R 并生成文档：

   library(roxygen2)
   roxygenise('test')
   

4. 查看生成的 trim.Rd 文件（在 test/man 中）：

   \name{trim}
   \alias{trim}
   \title{trim white spaces from a string}
   \usage{
     t
   }
   \arguments{
     ... # rest of .Rd file - nothing wrong here.
   

看看怎么只有\usage{t} ??

当然，当运行R CMD check 时，会收到关于\usage 中未出现的记录参数的错误，但这是因为\usage 被截断了。

有谁知道为什么会发生这种情况以及我该如何解决？ roxygen2 中的某些东西可能依赖于在 Mac、Windows 和 Linux 中运行但不适用于 Cygwin 的东西？

干杯（为此我一直在扯头发）。

更新 #2：

我一直在使用从 Cygwin 的包管理器安装的 R，而不是我的 Windows R（即C:/Program Files/R/R-2.14.2/bin 中的那个） - 我没有意识到 Windows R 可以在 Cygwin 下运行。

如果我在 Cygwin 中使用 Windows R，该错误就会消失。如果我在 Cygwin 中使用 Cygwin R，则存在该错误。

我只能假设这是一些与 Cygwin R 相关的错误，而不是 roxygen2。

现在我将使用在 cygwin 中使用 Windows R 的解决方法（事实上，现在我知道我可以做到这一点，反正也不需要 Cygwin R！）。

Answer 1

这不是修复，而是解决方法。

我一直在使用从 Cygwin 的包管理器安装的 R，而不是我的 Windows R（即 C:/Program Files/R/R-2.14.2/bin 中的那个） - 我没有意识到 Windows R可以在 Cygwin 下工作。

如果我在 Cygwin 中使用 Windows R，该错误就会消失。如果我在 Cygwin 中使用 Cygwin R，则存在该错误。

我只能假设这是一些与 Cygwin R 相关的错误，而不是 roxygen2。

现在我将使用在 cygwin 中使用 Windows R 的解决方法（事实上，现在我知道我可以做到这一点，无论如何都不需要 Cygwin R）。这仍然让我可以访问像 make、sed 和 grep 这样的 linux 命令，但让我可以让文档正常工作。

问题仍然存在，Cygwin 中的 Cygwin-R（不是 Cygwin 中的 Windows-R）会导致此错误，但可能不再与 roxygen2 相关。