From Kurt.Hornik at wu-wien.ac.at  Fri Jun 10 07:07:21 2005
From: Kurt.Hornik at wu-wien.ac.at (Kurt Hornik)
Date: Fri, 10 Jun 2005 07:07:21 +0200
Subject: [Rd] Question about .Rd syntax
In-Reply-To: <42A91842.9090509@sciviews.org>
References: <42A91842.9090509@sciviews.org>
Message-ID: <17065.8201.685160.235828@beren.wu-wien.ac.at>

>>>>> Philippe Grosjean writes:

> Hello all,
> In one of my packages, I have the following warning with R-devel, but no 
> problems with R 2.1.0, or R patched:

> ** checking Rd \usage sections ... WARNING
> Bad \usage lines found in documentation object 'guiStart':
>    guiStart(gui = "\"

> Functions with \usage entries need to have the appropriate \alias entries,
> and all their arguments documented.
> The \usage entries must correspond to syntactically valid R code.
> See chapter 'Writing R documentation files' in manual 'Writing R
> Extensions'.

> my function is:

> "guiStart" <-
> function(gui = "\"%SciViews_Home%/bin/RConsole.exe\" -connect") {
>     ....
> }

> and the way it is defined in \usage:
> \usage{
>    guiStart(gui = "\"%SciViews_Home%/bin/RConsole.exe\" -connect")
> }

> I am pretty sure it is a stupid error I made regarding \", or something 
> similar. Could someone tell me what that stupid error really is?

You need to escape the Rd comment character % as \%.

-k

> Thanks.

> Philippe

> ..............................................<?}))><........
>   ) ) ) ) )
> ( ( ( ( (    Prof. Philippe Grosjean
>   ) ) ) ) )
> ( ( ( ( (    Numerical Ecology of Aquatic Systems
>   ) ) ) ) )   Mons-Hainaut University, Pentagone (3D08)
> ( ( ( ( (    Academie Universitaire Wallonie-Bruxelles
>   ) ) ) ) )   8, av du Champ de Mars, 7000 Mons, Belgium
> ( ( ( ( (
>   ) ) ) ) )   phone: + 32.65.37.34.97, fax: + 32.65.37.30.54
> ( ( ( ( (    email: Philippe.Grosjean at umh.ac.be
>   ) ) ) ) )
> ( ( ( ( (    web:   http://www.umh.ac.be/~econum
>   ) ) ) ) )          http://www.sciviews.org
> ( ( ( ( (
> ..............................................................

> ______________________________________________
> R-devel at stat.math.ethz.ch mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel



[Rd] Question about .Rd syntax
Kurt Hornik