[Roxygen-devel] Line break bug when use.Rd2=TRUE

Vinh Nguyen vqnguyen at uci.edu
Sat Oct 9 19:00:30 CEST 2010


Thanks Laurent for your response.  After some staring at the code and
debugging, I found that the reason is caused by the @name tag (I had
both @name and @rdname) when documenting a function and class with the
option use.Rd2=TRUE.  Removing @name removes the line break issue
coming from the generated aliases.

I think roxygen automatically generates an alias with -method and
-class from the @name tag and is somehow picking up the "\n".

I also want to note that I have both @name and @rdname in the -package
documentation and this did not cause an issue.

Vinh

On Fri, Oct 8, 2010 at 1:45 PM, Laurent Gatto <laurent.gatto at gmail.com> wrote:
> Dear Vinh,
>
> This issue sounds familiar, even tough I did not quite experience the
> \n at the exact same place.
> May be the thread '[Roxygen-devel] S4 class name ending with \n' can
> be of any help:
> http://lists.r-forge.r-project.org/pipermail/roxygen-devel/2010-September/000152.html
>
> Best wishes,
>
> Laurent
>
>
> On 8 October 2010 21:30, Vinh Nguyen <vqnguyen at uci.edu> wrote:
>> The first yields inference-class.Rd, which gives me:
>> \name{inference-class}
>> \alias{inference-class
>> -class}
>> \alias{inference-class}
>> ...
>>
>> The error is coming from the newline in the alias line (gives me an
>> error with R CMD check).
>>
>> Similarly, the second documentation yields
>> \name{infer-methods}
>> \alias{infer-methods
>> ,-method}
>> \alias{infer-methods}
>> ...
>>
>> Same error.
>>
>> Why is it generating this new line?  Thanks.
>>
>> Vinh
>> --
>> Vinh Nguyen
>> Department of Statistics
>> Donald Bren School of ICS
>> 2231 Bren Hall
>> University of California, Irvine
>> Irvine, CA 92607
>> vqnguyen at uci.edu | http://www.ics.uci.edu/~vqnguyen/
>> Schedule a meeting: http://tungle.me/VinhNguyen
>> _______________________________________________
>> Roxygen-devel mailing list
>> Roxygen-devel at lists.r-forge.r-project.org
>> https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/roxygen-devel
>>
>
>
>
> --
> Laurent Gatto
> slashhome.be
>


More information about the Roxygen-devel mailing list