CODEWITHSUNDEEP
rfunction
Jasmine
Jasmine

Reputation: 123

How to create help for my functions written by in R?

I want to create help pages for my own functions. So if I define a function: e.g:

myfunct <- function(x,y,z){...}

And if I type ?myfunct I'd get the parameter specifications that I give.

Is there a way to do that?

Upvotes: 7

Views: 4086

Answers (1)

user1436187
user1436187

Reputation: 3376

You should create a package. I suggest to use the Roxygen package for documentation.

http://roxygen.org/ http://cran.r-project.org/doc/manuals/R-exts.html

In addition to ESS both rstudio http://www.rstudio.com/ide/ and statet http://www.walware.de/goto/statet support it.

Upvotes: 5

Related Questions