Rstudio自己的方法/函数minihelp

如果我编写一个方法或函数，如何获得写入函数时显示的“minihelp”（其特殊术语我不知道）？例如对于“情节”它存在;在一种“工具提示”Rstudio自己的方法/函数minihelp

x= 
y= 
... =

键入

>plot([TAB]

那么下面的节目，如果你选择，例如“X”，再经过二级以下提示显示：

x 
the coordinates of points in the plot. Alternatively, a single plotting 
structure, function or any R object with a plot method can be provided.

一些信息，但不是关键的问题：我正在与Rstudio合作，为ExpressionSet类编写多个S4泛型/方法。可悲的是我无法找到一个很酷的谷歌关键字，所以我希望你能帮助我！

伊迪丝：以下question是关于我的一样，但我仍然认为我已经写包正在进行的问题，每一个功能是记录与roxygen，我也跟着哈德利描述。尽管如此，这些工具提示并没有显示出来。

在链接的问题，它说，“帮助文件必须生成” - 我假设生成？myS4Method显示适当的帮助页面。有任何想法吗？

来源

2017-09-21 groebsgr

这将是一个重复的是 - 但即使通过创建一个包它不工作.. – groebsgr

您正在寻找的功能来自RStudio解析软件包文档的方式。如果您创建了一个包，您可以将Roxygen注释添加到您的函数或类中。这些注释在创建包到文档文件中时会被解析，这些文档可以看作是函数的帮助。

如果您运行命令?plot，您将看到一个参数列表。这些是可以传递给函数的参数，这是RStudio中的工具提示告诉你的。

要让RStudio为您提供有关您正在使用的功能的信息，您应该将您的S4课程打包到一个包中（Hadley Wickham's tutorial），并确保它们被正确记录。 RStudio将负责其余部分。

来源

2017-09-21 15:22:53 Eumenedies

因此，我已经使用Roxygen注释 - 文档devtools :: document（）运行时没有警告或错误。？“myfunction”正常工作，所有参数都在那里正确描述。尽管如此，工具提示并未显示 - 我是否错过了某些部分？ – groebsgr

您是否正在从包装中加载功能？查看哈德利对[this]的评论（https://stackoverflow.com/questions/21565526/is-it-possible-to-get-rstudio-to-show-function-arguments-and-descriptions-for-cu）的问题。 – Eumenedies

是的我是:(必须有我监督的东西... – groebsgr

Rstudio自己的方法/函数minihelp

回答

相关问题