From nashjc at uottawa.ca  Sat Apr 25 13:11:47 2015
From: nashjc at uottawa.ca (Prof J C Nash (U30A))
Date: Sat, 25 Apr 2015 07:11:47 -0400
Subject: [Rd] Title case in DESCRIPTION for package where a word is a
 function name
In-Reply-To: <553AC0E5.4000305@statistik.tu-dortmund.de>
References: <553A62B9.3070709@uottawa.ca>
	<loom.20150424T224308-950@post.gmane.org>
	<553AC0E5.4000305@statistik.tu-dortmund.de>
Message-ID: <553B7673.7020201@uottawa.ca>

Hendrik pointed out it was the parentheses that gave the complaint.
Single quotes and no parentheses seem to satisfy R CMD check. Perhaps
that needs to be in the WRE.

However, I have for some time used the parentheses to distinguish
functions from packages. optim() is a function, optimx a package.
Is this something CRAN should be thinking about? I would argue greater
benefit to users than title case.

JN


On 15-04-24 06:17 PM, Uwe Ligges wrote:
> 
> 
> On 24.04.2015 22:44, Ben Bolker wrote:
>> Prof J C Nash (U30A <nashjc <at> uottawa.ca> writes:
>>
>>>
>>> I was preparing a fix for a minor glitch in my optimx package and R CMD
>>> check gave an error that the title was not in title case.
>>
>>    [snip] to make Gmane happy ...
>>
>>> I have found
>>>
>>> A Replacement and Extension of the _optim()_ Function
>>>
>>> does not get the complaint, but I'm not sure the underscore is allowed.
>>>
>>> Given that I've obeyed the RTFM rule, I'm wondering what to do now.
>>
>>    Presumably you should ask the CRAN maintainers?  That seems to
>> be the only possible answer -- I don't think anyone else can guess
>> very accurately ...
> 
> From WRE:
> 
> "Refer to other packages and external software in single quotes, and to
> book titles (and similar) in double quotes."
> 
> Other non-English usage (as documented for the Description field; this
> inlcudes function names) can also be used in single quotes.
> 
> Best,
> Uwe Ligges
> 
> 
>>
>>    Ben Bolker
>>
>> ______________________________________________
>> R-devel at r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-devel
>>



[Rd] Title case in DESCRIPTION for package where a word is a function name
Prof J C Nash (U30A