跳到内容

hadley/helper(哈德利/助手)

存储库文件导航

助手

Helper是一个R包,它改进了友好的HTML文档。通过指向其他包、函数别名和函数源的链接,只需单击即可找到信息。使用综合搜索栏,可以快速轻松地搜索所有R包。

的心脏助手在本地托管。显示所有文档不需要互联网,而搜索栏、RSS提要和评论系统的功能需要互联网连接。

发展助手在Revolution Analytics的慷慨支持下,实现了这一目标。

主要特点

  • 主屏幕

    • 加载/安装的所有软件包列表
    • 所有R手册的链接
    • 允许您更新过期的软件包
  • 程序包页面

    • 每个帮助页链接都被分成组
    • 软件包小插曲和演示的链接
    • 一般信息列表:作者、建议、依赖、反向依赖关系和CRAN信息
    • 最新版本的更改日志
    • Disqus评论系统
  • 主题页面

    • 描述、用法、参数、详细信息、值和源的显示
    • 使用链接到每个主要功能的源
    • 作者列表和“另请参阅”
    • 具有完整语法突出显示并能够嵌入非交互式的示例浏览器中的示例输出
    • 示例中使用的顶级函数列表
    • Disqus评论系统
  • 源页面

    • 功能描述
    • 完整语法突出显示
    • 源代码中使用的顶级函数列表
    • Disqus评论系统
  • 演示页

    • 演示说明
    • 同一软件包中其他演示的链接
    • 演示中使用的顶级功能列表
    • 完整的语法突出显示并能够嵌入非交互式演示浏览器中的输出

安装

要安装助手,您首先需要安装一些软件包:

  • 来自CRAN:install.packages(c(“stringr”、“digest”、“mutatr”、“brew”和“testtat”)
  • 来自github:http://github.com/hadley/sinartra

跑步助手

从已安装的软件包运行:

库(助手)帮助程序()

运行开发版本:

#将工作目录设置为helper包目录库(devtools)load_all(“helper”)帮助程序()

仅供服务器开发人员使用!!!

遵循教程来了解它的工作原理。

(开发人员)安装溶胶,您首先需要安装酿造

  • 安装brew:ruby-e“$(curl-fsShttp://gist.github.com/raw/323731/install_homebrew.rb)"

  • 用brew安装solr:brew安装solr

  • 将solr-conf中的两个文件添加/替换到solr的example/solr/conf文件夹

  • 执行命令java-jar启动.jar在/example-solr目录中启动服务器

    • 我的solr安装在/usr/local/Cellar/solr/1.4.0/
  • 要添加/更新文件,请从R执行一个索引命令

    index_topic(包,主题) index_package(程序包) 索引()

设计灵感

关于

R的另一种html帮助系统

资源

星星

观察者

叉子

发布

未发布版本

包装

未发布包