我正在阅读texinfo中的R FAQ源,并认为如果将其解析为R结构会更容易管理和扩展。有几个与此相关的现有示例:
财富包
中文条目
文件
每个都有一些理想的功能。
在我看来,常见问题解答在 R 社区中没有得到充分利用,因为它们缺乏 i) 从 R 命令行轻松访问(即通过 R 包);ii) 强大的搜索功能;iii) 交叉引用;iv) 贡献包的扩展。从包bibtex
和中汲取灵感fortunes
,我们可以构想出一个新系统,其中:
可以从 R 中搜索常见问题解答。典型的调用类似于
fortune()
界面:faq("lattice print")
、 或faq() #surprise me!
、faq(51)
、faq(package="ggplot2")
。包可以提供自己的
FAQ.rda
,格式还不清楚(见下文)Sweave
/knitr
提供驱动程序以输出格式良好的 Markdown/LaTeX 等。
问题
但是,我不确定最好的输入格式是什么。用于转换现有常见问题解答或添加新条目。
将 R 语法与嵌套列表树(或临时 S3/S4/refclass
或structure
,
\list(title = "Something to be \\escaped", entry = "long text with quotes, links and broken characters", category = c("windows", "mac", "test"))
Rd
文档,即使本身不是 R 结构(它更像是 LaTeX 的一个子集,具有自己的解析器),也许可以提供一个更吸引人的输入格式示例。它还有一组工具来解析R 中的结构。然而,它目前的目的是相当具体和不同的,面向 R 函数的一般文档,而不是 FAQ 条目。它的语法也不理想,我认为更现代的标记,比如降价,会更具可读性。
还有其他东西吗,也许是将markdown文件解析为R结构的例子?将 Rd 文件偏离其预期目的的示例?
总结
我想提出:
1- R 结构(可能是类)的良好设计,可以将fortune
包扩展到更一般的条目,例如常见问题解答项目
2- 一种更方便的格式来输入新的常见问题解答(而不是当前的 texinfo 格式)
3- 一个解析器,用 R 或其他语言(bison?)编写,用于将现有的常见问题解答转换为新的结构 (1),和/或将新的输入格式 (2) 转换为 R 结构。
更新 2:在赏金期的最后两天,我得到了两个答案,都很有趣但完全不同。因为这个问题非常广泛(可以说是不合适的),所以没有一个答案提供完整的解决方案,因此我(无论如何现在)不会接受答案。至于赏金,我将其归因于在赏金到期之前投票最多的答案,希望有一种方法可以更平均地分配它。