[R] i need help in documentation

R. Michael Weylandt michael.weylandt at gmail.com
Thu Jul 5 17:17:58 CEST 2012


R does not, to my knowledge, have anything quite like Python's
docstrings (which seems to be what you are talking about) but you
might look at Roxygen2 on CRAN which should get you started in this
direction.

Best,
Michael

On Thu, Jul 5, 2012 at 7:37 AM, purushothaman <purushothaman.b at ge.com> wrote:
> Hi,
>
> i am new in R development ,
>
> so i need help in documentation from comments in R file
>
> for example
>
> sample<-function(filepath)
> {
>
>         ##title<< read csv file
>         ##author<< Purushoth
>         ##description this function is used to read a csv file
>     output<-read.csv(filepath)
>    return(output)
> }
>
> i need to get html document file using this comments
>
>
> Thanks
> B.Purushothaman
>
> --
> View this message in context: http://r.789695.n4.nabble.com/i-need-help-in-documentation-tp4635471.html
> Sent from the R help mailing list archive at Nabble.com.
>
> ______________________________________________
> R-help at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-help
> PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
> and provide commented, minimal, self-contained, reproducible code.



More information about the R-help mailing list