R语言:startDynamicHelp()函数中文帮助文档(中英文对照)

loveR

startDynamicHelp(tools)
startDynamicHelp()所属R语言包：tools

                                        Start the Dynamic HTML Help System
                                         启动动态HTML帮助系统

                                         译者：生物统计家园网 机器人LoveR

描述----------Description----------

This function starts the internal help server, so that HTML help pages are rendered when requested.
此功能启动内部的帮助服务器，因此，HTML帮助页面请求时呈现。


用法----------Usage----------


startDynamicHelp(start=TRUE)



参数----------Arguments----------

参数：start
logical: whether to start or shut down the dynamic help system.
逻辑：是否启动或关闭动态帮助系统。


Details

详情----------Details----------

This function starts the internal HTTP server, which runs on the loopback interface (127.0.0.1).  If options("help.ports") is set to a vector of integer values, startDynamicHelp will try those ports in order; otherwise, it tries up to 10 random ports to find one not in use.  It can be disabled by setting the environment variable R_DISABLE_HTTPD to a non-empty value.
此功能启动内部HTTP服务器，它运行loopback接口（127.0.0.1）。如果options("help.ports")设置为一个整数向量，startDynamicHelp将尝试以这些端口，否则，它会尝试找到一个不使用多达10个随机端口。它可以通过设置环境变量R_DISABLE_HTTPD一个非空值被禁用。

startDynamicHelp is called by functions that need to use the server, so would rarely be called directly by a user.
startDynamicHelp被称为需要使用服务器的功能，所以很少会被称为直接用户。

Note that options(help_type="html") must be set to actually make use of HTML help, although it might be the default for an R installation.
注意options(help_type="html")必须设置实际使用HTML帮助，尽管它可能是一个R安装的默认。

If the server cannot be started or is disabled, help.start will be unavailable and requests for HTML help will give text help (with a warning).
如果服务器不能启动或禁用，help.start将无法和HTML帮助的请求，将文本帮助（警告）。

The browser in use does need to be able to connect to the loopback interface: occasionally it is set to use a proxy for HTTP on all interfaces, which will not work – the solution is to add an exception for 127.0.0.1.
所使用的浏览器需要能够连接到Loopback接口：偶尔，它被设置为使用一个HTTP代理上的所有接口，将无法正常工作 - 的解决办法是添加一个例外127.0.0.1。


值----------Value----------

The chosen port number is returned invisibly (which will be 0 if the server has been stopped).
所选择的端口号返回无形（这将是0如果服务器已停止）。


参见----------See Also----------

help.start and help(help_type = "html") will attempt to start the HTTP server if required
help.start和help(help_type = "html")将尝试启动HTTP服务器，如果需要的话

Rd2HTML is used to render the package help pages.
Rd2HTML用于呈现包帮助页面。

转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。


注：
注1：为了方便大家学习，本文档为生物统计家园网机器人LoveR翻译而成，仅供个人R语言学习参考使用，生物统计家园保留版权。
注2：由于是机器人自动翻译，难免有不准确之处，使用时仔细对照中、英文内容进行反复理解，可以帮助R语言的学习。
注3：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。