改善R的帮助

时间:2012-03-14 22:30:31

标签: r documentation

我总是徘徊其他人对R帮助的看法。经过几年的使用后,我终于决定尝试做一些事情,因为咬牙的感觉并没有因多年的使用而消失。 :)此外,我认为这是R不会对其他统计软件进行评估的少数事情之一。所以,到了这一点:

我感觉(通过学习编程语言的一些经验,当我不是主要的程序员而是经济学家/统计学家)时,帮助的结构确实有帮助,我想让它顺其自然

  • 基本语法(基本上我真的只是指必要的参数)
  • “假人”的例子,看它的作用
  • 点击这里,如果你想知道更多菜单/按钮

我曾经使用过的最好的文档可能是Mathematica之一,在这里查看例子 - 好吧,因为我是新的它阻止我发布两个以上的链接,所以寻找参考wolfram for Fit命令(它是某种方式与下面的内容有关。)

所以我所做的是我为适合线性模型(http://stat.ethz.ch/R-manual/R-patched/library/stats/html/lm.html)提供了R帮助文件,并为我提供了一些更易读的形状。 所以我构建了一些其他版本(实际上是两个)看http://pinda.sifruje.cz/。 “原始”只是相同的文字,只有一些基本的东西解决了(在我的27英寸显示器上,如果我使浏览器全屏显示原始帮助几乎是不可读的,因为它从一端延伸到另一端。接下来我们已经有一些非常好的字体,所以为什么不使用它们,这里是Linux Biolinum,我做了一些对我的审美变化......)。 “习惯”更深入,试图实现我的一些想法。这些按钮非常快速,仅作为示例。此外,我并不认为代码是好的,我只花了一两个小时就看到了一些已经存在于网络中的部分。把它作为一些示范。

我希望您收到的是您对此主题的看法。我做的事情甚至算法很容易(一些解析器可能解析现有的帮助文件)。这里唯一的附加值是让重要的东西更加明显。我还添加了“假人”的例子。

所以请告诉我你的想法。我有点忙,如果我做任何事情,我想事先仔细考虑一下。如果有人有兴趣帮助,或者如果他正在运行类似的项目,请告诉我。

谢谢, 托马斯。

1 个答案:

答案 0 :(得分:0)

R帮助系统没有"踢屁股"与其他统计软件包相比?

我们还在讨论哪些其他套餐?塔塔? SAS!?什么是好的"帮助系统非常主观。有些人会要求冗长,有些人会说简约。

事实上,很多R帮助条目看起来都很神秘。取自"描述" seq()函数(一个相对简单的函数):

  

"生成常规序列。 'seq'是标准通用的a        默认方法。 'seq.int'是一个可以快得多的原语        但有一些限制。 'seq_along'和'seq_len'非常好        两种常见案例的快速原语。"

第一句话描述了你需要知道的一切。其余部分非常神秘,直到您开始学习语言定义。此外,仅仅使用大多数功能,您无需了解此类信息。在开发新方法和类时,它变得相关。帮助条目不应完整阅读。这取决于你的目的。

"R Language Definition"手册是对这个术语的一个很好的介绍。

我不怀疑可以在官方文件中提供一些额外的例子。对于计量经济学家来说,统计学家的洞察力可能并非如此,反之亦然。