[Roxygen-devel] roxygen2: tag @aliases for S4 method generates quoted aliases
Renaud Gaujoux
renaud at cbio.uct.ac.za
Tue Aug 16 16:27:13 CEST 2011
Hi,
adding a tag such as:
@aliases myS4method,matrix-method
generates the following Rd quoted tag:
\alias{"myS4method,matrix-method"}
this makes R CMD check report the alias as missing.
There is not such issue with non S4 aliases.
The issue might come from the presence of the comma in the alias,
although this is the correct syntax to declare S4 aliases.
By the way is there a reason why the aliases are not generated
automatically, since one knows exactly which doc to put in which file,
as well as the type and signatures of the documented object.
For example, when documenting a S4 generic, the aliases to the different
methods could be put together in the same Rd file, as it is already done
for the descriptions for the different methods.
Thank you.
Renaud
###
UNIVERSITY OF CAPE TOWN
This e-mail is subject to the UCT ICT policies and e-mail disclaimer published on our website at http://www.uct.ac.za/about/policies/emaildisclaimer/ or obtainable from +27 21 650 9111. This e-mail is intended only for the person(s) to whom it is addressed. If the e-mail has reached you in error, please notify the author. If you are not the intended recipient of the e-mail you may not use, disclose, copy, redirect or print the content. If this e-mail is not related to the business of UCT it is sent by the sender in the sender's individual capacity.
###
More information about the Roxygen-devel
mailing list