搜索
查看: 1839|回复: 0

[R] R包里面的函数应该写详细的readme

[复制链接]

634

主题

1182

帖子

4030

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
4030
发表于 2017-5-7 10:13:47 | 显示全部楼层 |阅读模式
当然,很多人都讨厌写这个,我就写的很差,但是基本样子得装出来:
我一般写的是:https://github.com/jmzeng1314/IR ... /R/barplot_cdr3aa.R
里面有下面这些:
Your documentation must include:
  • Name: the name of the document (added automatically by roxygen2)
  • Alias: The function documented (added automatically by roxygen2, but can be added manually using @alias)
  • Title: Documentation title (first line of roxygen2 block)
  • Usage: a list of arguments and their defaults (added automatically by roxygen2)
  • Arguments: description of each argument (@param)
  • Description: Short description of what the function does (added automatically by roxygen2, but can be added manually using @description)
It should include:
  • Value: what the function returns (@return)
  • Details: detailed description of function usage (@details)
  • Examples: self-contained examples of the code in action (@examples)
It may include:
  • Authors: Who wrote the functions (@authors)
  • One document with multiple functions (multiple aliases: use @alias and separate each function with a space)
  • Anything else that’s relevant
ALL your functions must be documented somewhere with an alias, and ALL the arguments of each function must be described under @param. Make your documentation as useful, thorough and accurate as possible.






上一篇:R包的基本结构是什么
下一篇:常见概率分布及在R中的应用
你这个问题很复杂,需要打赏,请点击 http://www.bio-info-trainee.com/donate 进行打赏,谢谢
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

QQ|手机版|小黑屋|生信技能树 ( 粤ICP备15016384号  

GMT+8, 2019-10-14 22:11 , Processed in 0.035721 second(s), 26 queries .

Powered by Discuz! X3.2

© 2001-2013 Comsenz Inc.