From pgilbert at bank-banque-canada.ca  Wed May 11 22:20:36 2011
From: pgilbert at bank-banque-canada.ca (Paul Gilbert)
Date: Wed, 11 May 2011 20:20:36 +0000
Subject: [Rd] How to document man/*.Rd pages with images?
In-Reply-To: <C9F056EB.4153%sean.mcguffee@gmail.com>
References: <C9F056EB.4153%sean.mcguffee@gmail.com>
Message-ID: <6441154A9FF1CD4386AF4ABF141A056D215A2395@WMEXOSCD2-N1.bocad.bank-banque-canada.ca>

I thought the usual logic was that you might put graphs and images into a vignette, and you might refer to the vignette in an Rd help file, but you would not put the graphs into the help because ? access to the page cannot assume that you actual have a graphics device. Of course, examples in the Rd file can generate the graphs.

Paul

> -----Original Message-----
> From: r-devel-bounces at r-project.org [mailto:r-devel-bounces at r-
> project.org] On Behalf Of Sean Robert McGuffee
> Sent: May 11, 2011 3:08 PM
> To: r-devel at r-project.org
> Subject: [Rd] How to document man/*.Rd pages with images?
> 
> Hi,
> I?m trying to figure out how to put images into my package?s help
> documentation. I?ve gotten to the point where I can put the images in
> the
> /inst/doc/ directory. I have also gotten to the point where I have
> package
> checks without any warnings. I couldn?t find the terms ?picture,?
> ?image,?
> or ?graphic? in a text search within the Writing R Extensions: 2
> Writing R
> documentation files
> <http://cran.r-project.org/doc/manuals/R-exts.html#Writing-R-
> documentation-f
> iles>
> I tried a couple of LaTeX guesses, but they lead to the following
> errors on
> check:
> Warning: /LAB/SRM/PROGS/R_PACKAGES/Ralign/man/Ralign139.Rd:3:
> unexpected
> UNKNOWN '\usepackage'
> Warning: /LAB/SRM/PROGS/R_PACKAGES/Ralign/man/Ralign139.Rd:36: unknown
> macro
> '\includegraphics'
> What is the right way to do this?
> Thanks,
> Sean
> 
> 
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
====================================================================================

La version fran?aise suit le texte anglais.

------------------------------------------------------------------------------------

This email may contain privileged and/or confidential in...{{dropped:26}}



[Rd] How to document man/*.Rd pages with images?
Paul Gilbert