R devel - Dec 2010 - \VignetteKeywords{}, for KEYWORDS or for free-tagging?

Hi R-devel,

[Question]:

* Is there a KEYWORDS file to lookup 'keywords' to supply
the vignette command, '\VignetteKeywords{}'?

-or, is the pkg writer free to tag the vignette using any
keywords he/she chooses? i.e., free-tagging.

Thank you,

+ Elliot Kleiman
__________________________
San Diego State University
http://www.sdsu.edu/

Hi Kurt,

Thank you for the info!

However, I would also like to ask:

* Since the user may use any words as 'keywords',
what is the purpose of this command and what are
the benefits of using it?

* Where is the documentation for the '\Vignette*'
commands?

Because other than the '\VignetteIndexEntry' command,
I could not find any mentioning of them in the R-exts
manual, http://cran.r-project.org/doc/manuals/R-exts.html.

Best,

+ Elliot

On Mon, 3 Jan 2011, Kurt Hornik wrote:
>>>>>> Elliot Todd Kleiman writes:
>
>> Hi R-devel,
>> [Question]:
>
>> * Is there a KEYWORDS file to lookup 'keywords' to supply
>> the vignette command, '\VignetteKeywords{}'?
>
>> -or, is the pkg writer free to tag the vignette using any
>> keywords he/she chooses? i.e., free-tagging.
>
> For vignette keywords, the latter.
>
> Best
> -k
>
>> Thank you,
>
>> + Elliot Kleiman
>> __________________________
>> San Diego State University
>> http://www.sdsu.edu/
>
>> ______________________________________________
>> R-devel at r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-devel
>
>

Hi Kurt,

Thank you very much for clarifying this.

I hope that some documentation may be
written about these commands and added
to one of the manuals in the future.

+ Elliot


On Wed, 5 Jan 2011, Kurt Hornik wrote:
>>>>>> Elliot Todd Kleiman writes:
>
>> Hi Kurt,
>> Thank you for the info!
>
>> However, I would also like to ask:
>
>> * Since the user may use any words as 'keywords',
>> what is the purpose of this command and what are
>> the benefits of using it?
>
>> * Where is the documentation for the '\Vignette*'
>> commands?
>
>> Because other than the '\VignetteIndexEntry' command,
>> I could not find any mentioning of them in the R-exts
>> manual, http://cran.r-project.org/doc/manuals/R-exts.html.
>
> I don't think that the vignette metadata are currently used "a
lot".
> They make it into the vignette index but users don't get to play with
> this.  (There are long-standing plans to integrate vignettes into the
> help system [with help and help.search], though.)
>
> Best
> -k
>
>> Best,
>
>> + Elliot
>
>> On Mon, 3 Jan 2011, Kurt Horniks wrote:
>
>>>>>>>> Elliot Todd Kleiman writes:
>>>
>>>> Hi R-devel,
>>>> [Question]:
>>>
>>>> * Is there a KEYWORDS file to lookup 'keywords' to
supply
>>>> the vignette command, '\VignetteKeywords{}'?
>>>
>>>> -or, is the pkg writer free to tag the vignette using any
>>>> keywords he/she chooses? i.e., free-tagging.
>>>
>>> For vignette keywords, the latter.
>>>
>>> Best
>>> -k
>>>
>>>> Thank you,
>>>
>>>> + Elliot Kleiman
>>>> __________________________
>>>> San Diego State University
>>>> http://www.sdsu.edu/
>>>
>>>> ______________________________________________
>>>> R-devel at r-project.org mailing list
>>>> https://stat.ethz.ch/mailman/listinfo/r-devel
>>>
>>>
>
>