[R-pkg-devel] Roxygen: function documentation to get \item{...} in .rd file

[Joris Meys]

Hi Knut,

on a sidenote: did you try the Rd2roxygen package? That could also make
your work a lot easier.

https://cran.r-project.org/web/packages/Rd2roxygen/index.html
Cheers
Joris

On Mon, Mar 12, 2018 at 8:15 PM, Joris Meys <Joris.Meys at ugent.be> wrote:

> Hi Knut,
>
> If you want to add parameters, you need to use the tag @param :
>
> #' @param x a numeric vector
>
> will translate to:
>
> \item{x}{a numeric vector}
>
> in the \arguments section of the .Rd file.
>
> If you want to add extra description lists (eg for elements of a list in
> the output), you can use \describe:
>
> #' \describe{
> #'    \item{name}{a numeric vector with names}
> #' }
>
> If you're not familiar with roxygen2 at all, you can start at the vignette
> here: https://cran.r-project.org/web/packages/roxygen2/vignettes/rd.html
>
> More information can be found in the book of Hadley on writing packages,
> section about documentation : http://r-pkgs.had.co.nz/man.html
>
> Cheers
> Joris
>
> On Mon, Mar 12, 2018 at 8:07 PM, Knut Krueger <rhelp at krueger-family.de>
> wrote:
>
>> I am  converting a package from creating the .rd files manually to
>> roxygen.
>>
>> I do not know how to add the additional parameters to the function
>> description, so that the  \item{...}{ some parameters } will be created in
>> the .rd file
>>
>> Kind regards Knut
>>
>> ______________________________________________
>> R-package-devel at r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-package-devel
>>
>
>
>
> --
> Joris Meys
> Statistical consultant
>
> Department of Data Analysis and Mathematical Modelling
> Ghent University
> Coupure Links 653, B-9000 Gent (Belgium)
>
> <https://maps.google.com/?q=Coupure+links+653,%C2%A0B-9000+Gent,%C2%A0Belgium&entry=gmail&source=g>
>
> tel: +32 (0)9 264 61 79 <+32%209%20264%2061%2079>
> -----------
> Biowiskundedagen 2017-2018
> http://www.biowiskundedagen.ugent.be/
>
> -------------------------------
> Disclaimer : http://helpdesk.ugent.be/e-maildisclaimer.php
>



-- 
Joris Meys
Statistical consultant

Department of Data Analysis and Mathematical Modelling
Ghent University
Coupure Links 653, B-9000 Gent (Belgium)
<https://maps.google.com/?q=Coupure+links+653,%C2%A0B-9000+Gent,%C2%A0Belgium&entry=gmail&source=g>

tel: +32 (0)9 264 61 79
-----------
Biowiskundedagen 2017-2018
http://www.biowiskundedagen.ugent.be/

-------------------------------
Disclaimer : http://helpdesk.ugent.be/e-maildisclaimer.php

	[[alternative HTML version deleted]]