发布指南

一般建议贴在Bioconductor帮助网站。

修订日期:2018年5月9日

• 为什么
• 要点
• 与包维护人员的通信
• 在发布之前
• 作曲
• 回复
• 致谢和进一步阅读

为什么?

• 形式良好的问题能得到更好的回答，也有助于节省每个人的时间。

• 请记住，支持网站上的助手是志愿者，他们通常非常了解Bioconductor但不知道你已经做了什么，也不知道你正在做什么。下面的要点旨在帮助你提供足够的信息，一个有经验的人可以提供一个有用的答案，而不需要更多的信息。

［回到顶部］

要点

• 使用最新的Bioconductor2021年欧洲杯 ．确保您的包是最新的．

• 把你所有的R代码。

• 中出现的任何错误或警告消息的副本R．

• 如果你的问题涉及到实验数据，包括一个例子sample-level协变量数据(每个样本一行，每个协变量一列)。如果它有助于回答你的技术问题，并可以分享，解释你的实验背后的动机。

• 总是粘贴的输出sessionInfo ()在你帖子的最后。

• 如果可能的话，提供一个最小的、自包含的示例，以便其他人可以剪切粘贴到新的示例中R会话来再现你的问题。

• 如果该示例产生错误，则提供的输出回溯()错误发生后。

［回到顶部］

与包维护人员通信

• 用适当软件包的名称标记您的帖子。放置正确的标记很重要，因为这将触发系统向包维护人员自动发送电子邮件。大写并不重要，但对包装标签来说拼写很重要。

• 不要直接给包维护人员发邮件。尽可能将所有对话都保留在支持网站上，除非对方指示，否则不要回复到电子邮件。一些包维护人员为错误报告提供了另一个URL，可以在下面找到BugReports在包裹登陆页面上。

• 为什么?由于支持站点是公开的和可搜索的，因此它充当一个存档，为可能面临类似错误或问题的其他用户提供帮助。

［回到顶部］

在发布之前

• 阅读有关使用的软件包的小插图browseVignettes(“somepkg”)．搜索小插图文本中与你的问题相关的部分。

• 阅读有关R文档。如果你的功能有问题somefunc ()的相关章节somefunc ?，包括关于函数参数和函数输出的部分。

• 搜索支持网站上类似的帖子。搜索支持站点的最佳方法是使用谷歌通过从网站:support.bioconductor.org后面是一个空格、一组关键字和包名。

• 如果使用谷歌搜索支持站点没有帮助，那么请尝试搜索常见问题解答而且R-类似职位的档案。

• 确保你的问题切题。的Bioconductor支持网站主要是为了帮助人们解决使用的问题Bioconductor软件问题非-_Bioconductor_R应该询问软件包或一般统计信息R-或Stackoverflow．关于生物信息学的问题，但不是关于Bioconductor包裹可以邮寄到Biostars．

［回到顶部］

作曲

• 使用一个信息丰富的标题。这将有助于吸引响应者，并在他们搜索支持站点时帮助其他人。例如，标题行“时间课程实验使用limma”比只写“limma”更好。

• 如果您正在询问关于如何使用某个特定函数或包的建议，那么请详细解释您已经阅读过哪些文档，以及为什么这些文档还没有完全回答您的问题。这允许应答者回答您的特定问题，而不是简单地让您参考现有的文档。

• 如果您的问题与包开发有关，请发送电子邮件到bioc-devel列表；否则发布到Bioconductor支持网站．

• 如上所述，用适当软件包的名称标记您的帖子。

• 包含所有输出的代码块。使用前尾三重反勾来表示代码块(' ' ')．您可以直接从控制台复制和粘贴代码到反勾之间。

• 的结果总是包含一个代码块sessionInfo ()．这将表明您正在运行的操作系统平台版本以及R和R/的版本Bioconductor包版本。

• 仔细阅读你的帖子。它是否礼貌且容易理解?记住这些反应Bioconductor支持网站是来自试图提供帮助的志愿者。

• 还有一个使用markdown编辑器/格式化的有用教程。这可以在在这里

［回到顶部］

回复

• 使用添加评论按钮，以要求对答案作进一步解释，或回应有关更多信息的请求。

• 只使用添加答案如果您正在回答最初的问题，请按按钮。

• 如果可能的话，写一个能被具有不同科学背景、技能水平/技能概况的读者理解的答案。尽可能使用简单的英语，让最广泛的听众能够理解你的答案。

• 在回答问题的时候，可以考虑解释一下你是如何得到解决方案的。通过这种方式，你不仅可以帮助人们解决他们手头的问题，还可以在未来帮助他们自己。

• 无礼和人身攻击是不可接受的。

• 简洁是好的。但是要考虑到，那些对你来说很明显的信息可能对别人很有帮助。

• 提供其他相关线程或网站的url。

［回到顶部］

致谢

本张贴指南已改编自R-发布指南，各种意见和建议Bioconductor海报，灵感来自埃里克·史蒂文·雷蒙德的文章如何用聪明的方式提问．