R devel - Nov 2010 - [Roxygen-devel] Roxygen: @example tag does not work for me

> -----Urspr?ngliche Nachricht-----
> Von: roxygen-devel-bounces at lists.r-forge.r-project.org [mailto:roxygen-
> devel-bounces at lists.r-forge.r-project.org] Im Auftrag von Vinh Nguyen
> Gesendet: Donnerstag, 4. November 2010 04:04
> An: roxygen-devel at r-forge.wu-wien.ac.at
> Betreff: Re: [Roxygen-devel] Roxygen: @example tag does not work for me
> 
> Try @examples (with an 's'):
> 
> #' @examples
> #' my R code
> #' my R code
Hi Vinh,

thanks for the reply. What you suggest works just fine. It's not the thing
I'm looking for, though, since it means I have to "hard code" my
examples to
the actual script. That's exactly what I'm trying to get around. And
there
is this ominous "@example" tag that should get the job done, I just
don't
get how ;-)

Thanks for your comment though!

Regards, Janko
> 
> I'm not sure if placing a relative path (tests/foo.R) would work...try
> placing the actual code in the documentation chunk.
> _______________________________________________
> 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

I didn't know @example path/to/file.R was available until you
mentioned the UseR! 2010 presentation.  If that's the case, I'm going
to guess that you have to specify use.Rd2=TRUE in roxygenize(), as
I've found most of the new features mentioned in that presentation to
require it.


On Thu, Nov 4, 2010 at 6:14 AM, Janko Thyson
<janko.thyson at ku-eichstaett.de> wrote:
>
> Hi Vinh,
>
> thanks for the reply. What you suggest works just fine. It's not the
thing
> I'm looking for, though, since it means I have to "hard code"
my examples to
> the actual script. That's exactly what I'm trying to get around.
And there
> is this ominous "@example" tag that should get the job done, I
just don't
> get how ;-)
>
> Thanks for your comment though!
>
> Regards, Janko
>