[Roxygen-devel] Fwd: file which doesn't seem to process \dontrun properly in examples section

[Manuel J. A. Eugster]

Hi Brian,

I think this is a bug in the roclet: it interprets the @-sign as
the beginning of a "@fit$estimate[[1]]" roxygen-tag, which obviously
doesn't exist.

Can you please fill an issue at:

 > https://github.com/klutometis/roxygen/issues


As workaround, you could try to move the example to an external
file and use the "@example path/relative/to/packge/root" tag to
include it. However, I am  not sure if this works.



Best,

Manuel.



Am 04.06.2012 16:38, schrieb Brian G. Peterson:
> bump
>
> I know I sent this originally right in the middle of finals season.  I'm
> hopeful that has calmed down a bit and someone can give me a bit of a
> hand here.  This is the last remaining problem in the roxygen2
> conversion for PerformanceAnalytics, so I'd like to get this worked
> out...
>
>
> Thanks,
>
>   - Brian
>
>
> -------- Forwarded Message --------
> From: Brian G. Peterson<brian at braverock.com>
> To: roxygen-devel<roxygen-devel at r-forge.wu-wien.ac.at>
> Subject: file which doesn't seem to process \dontrun properly in
> examples section
> Date: Wed, 23 May 2012 13:41:25 -0500
>
> I've finished converting the 140+ page manual of package
> PerformanceAnalytics to roxygen2 documention mostly using Rd2roxygen.
>
> I had 14 R files that generated Rd errors after conversion, all of which
> I have now resolved except one.
>
> The attached .R file generates the attached .Rd file with these
> warnings:
> Writing chart.QQPlot.Rd
> Warning messages:
> 1: fit$estimate[[1]], is an unknown key in block chart.QQPlot.R:2
> 2: fit$estimate[[2]], is an unknown key in block chart.QQPlot.R:2
> 3: fit$estimate[[3]], is an unknown key in block chart.QQPlot.R:2
> 4: fit$estimate[[4]], is an unknown key in block chart.QQPlot.R:2
>
> and then, the generated .Rd file is missing a closing brace } on the
> example section:
>
>   R CMD Rd2pdf PerformanceAnalytics/man/chart.QQPlot.Rd
> Converting Rd files to LaTeX ...
>    chart.QQPlot.Rd
> Warning in parse_Rd("PerformanceAnalytics/man/chart.QQPlot.Rd", encoding
> = "unknown",  :
>    PerformanceAnalytics/man/chart.QQPlot.Rd:118: unexpected section
> header '\author'
> Warning in parse_Rd("PerformanceAnalytics/man/chart.QQPlot.Rd", encoding
> = "unknown",  :
>    PerformanceAnalytics/man/chart.QQPlot.Rd:121: unexpected section
> header '\references'
> Warning in parse_Rd("PerformanceAnalytics/man/chart.QQPlot.Rd", encoding
> = "unknown",  :
>    PerformanceAnalytics/man/chart.QQPlot.Rd:127: unexpected section
> header '\seealso'
> Warning in parse_Rd("PerformanceAnalytics/man/chart.QQPlot.Rd", encoding
> = "unknown",  :
>    PerformanceAnalytics/man/chart.QQPlot.Rd:131: unexpected section
> header '\keyword'
>
> <...>
>
> I can manually add the last brace to the examples section of the .Rd
> file, and I've done this for now, but this will break any time that
> roxygenize is run.
>
> Any idea what I've done wrong?  Or is this an error in the roclet
> parser?
>
> Regards,
>
>    - Brian
>
>
>
>
> _______________________________________________
> 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