From hpages at fhcrc.org  Mon May 16 23:23:28 2011
From: hpages at fhcrc.org (=?ISO-8859-1?Q?Herv=E9_Pag=E8s?=)
Date: Mon, 16 May 2011 14:23:28 -0700
Subject: [Rd] R html help system [Was: How to document man/*.Rd pages
 with images?]
In-Reply-To: <C9F6E208.4212%sean.mcguffee@gmail.com>
References: <C9F6E208.4212%sean.mcguffee@gmail.com>
Message-ID: <4DD195D0.70508@fhcrc.org>

Hi Sean,

On 11-05-16 11:15 AM, Sean Robert McGuffee wrote:
>
>
>
> On 5/13/11 8:20 PM, "Simon Urbanek"<simon.urbanek at r-project.org>  wrote:
>
>>
>> On May 13, 2011, at 7:08 PM, Sean Robert McGuffee wrote:
[...]
>>> In the satus quo, I can see how the choice of which pages to look at is
>>> dynamic if more than one comes up on a search, but it seems inefficient to me
>>> to have the page itself be dynamic. I think it would be a good idea if
>>> package authors could at least have an option to have their help pages
>>> produced as files either way.
>>
>> That decision is left to the user - you can use --html to generate html pages.
>
> This is appealing to me, but I can't seem to find any info about it. Maybe
> having the "--" part of the "--help" is throwing off my searches. I couldn't
> find "--help" when I searched R's help. If my package is named MyPackage,
> how would a user generate the html pages from it with "--html"?

I guess by "user" Simon meant the person who installed the package
(--html is an option to R CMD INSTALL), which AFAICT is not necessarily
the same as the user. In any case, it seems that this is not in the
hands of the package author.

H.


-- 
Herv? Pag?s

Program in Computational Biology
Division of Public Health Sciences
Fred Hutchinson Cancer Research Center
1100 Fairview Ave. N, M1-B514
P.O. Box 19024
Seattle, WA 98109-1024

E-mail: hpages at fhcrc.org
Phone:  (206) 667-5791
Fax:    (206) 667-1319



[Rd] R html help system [Was: How to document man/*.Rd pages with images?]
=?ISO-8859-1?Q?Herv=E9_Pag=E8s?=