From mauricio.zambrano at jrc.ec.europa.eu  Thu Dec  6 18:22:47 2012
From: mauricio.zambrano at jrc.ec.europa.eu (Mauricio Zambrano-Bigiarini)
Date: Thu, 06 Dec 2012 18:22:47 +0100
Subject: [Rd] Comments in the DESCRIPTION file
In-Reply-To: <509A3175.7010100@stats>
References: <509A2942.3050004@u-paris10.fr> <509A2FAA.1030404@gmail.com>
	<509A3175.7010100@stats>
Message-ID: <50C0D467.4060908@jrc.ec.europa.eu>

On 07/11/12 11:01, Prof Brian Ripley wrote:
> On 07/11/12 09:53, Duncan Murdoch wrote:
>> On 12-11-07 4:26 AM, Christophe Genolini wrote:
>>> Hi all,
>>>
>>> Is it possible to add comments in the DESCRIPTION file?
>>
>>
>> The read.dcf function is used to read the DESCRIPTION file, and it
>> doesn't support comments. (The current Debian control format
>> description does appear to support comments with leading # markers, but
>> R's read.dcf function doesn't support these.)
>>
>> You could probably get away with something like
>>
>> #: this is a comment
>>
>> since unrecognized fields are ignored, but I think this fact is
>> undocumented so I would say it's safer to assume that comments are not
>> supported.
>
> In that form, but lots of people have fields like
>
> Note: this is a comment
>
> and CRAN uses
>
> X-CRAN-Comment:
>
Dear Prof. Ripley,

Last week I used the 'X-CRAN-Comment' field in the DESCRIPTION file of a 
package that now is on CRAN. However, the comment I added is not shown 
on the web page of the package on CRAN 
(http://cran.r-project.org/web/packages/hydroPSO).

Does it mean that the 'X-CRAN-Comment' field is not actually used by 
CRAN or it is used but not shown on the CRAN web page of the package ?

Thanks in advance,

Mauricio Zambrano-Bigiarini

-- 
=================================================
Water Resources Unit
Institute for Environment and Sustainability (IES)
Joint Research Centre (JRC), European Commission
TP 261, Via Enrico Fermi 2749, 21027 Ispra (VA), IT
webinfo    : http://floods.jrc.ec.europa.eu/
=================================================
DISCLAIMER:\ "The views expressed are purely those of th...{{dropped:14}}



[Rd] Comments in the DESCRIPTION file
Mauricio Zambrano-Bigiarini