[Roxygen-devel] roxygen not escaping percent signs

[Peter Danenberg]

Forwarding this to the list, too, if you don't mind; what's the
warning from R CMD check?

----- Forwarded message from Mark Heckmann -----

From: Mark Heckmann
Subject: Re: [Roxygen-devel] roxygen not escaping percent signs
Date: Fri, 28 Jan 2011 10:40:14 +0100

I think to enter completely verbose code two things would be great:

1) a tag like @Rd to enter verbose code should suffice in most cases.
2) sometimes though it would be helpful if a default output from roxygen could be suppressed.

e.g.: I have the problem defining proper roxygen code for a extraction function "[“ for S4 classes. What I do is: 

#' extract parts of the repgrid object
#'
#' Methods for \code{"["}, i.e., subsetting of repgrid objects
#'
#' @aliases [,repgrid-method
#' @docType methods
#' @rdname extract-methods

This always results in a warning in R CMD check.
Here I would have liked to suppress some default output and be completely verbose.
Another solution would be to define it correctly in roxygen, but I was not able though.

All in all, I think being able to define what can be suppressed and add it in verbose code would just be great!!

Bests
Mark


Am 28.01.2011 um 10:30 schrieb Peter Danenberg:

> On Jan 28, 2011, at 1:20, Mark Heckmann <mark.heckmann at gmx.de> wrote:
>> One question concerning roxygen: is it possible to be completely verbose, i.e. typing ready to use .Rd code in roxygen in case what I want to do is not covered by the roxygen tags?
> 
> Interesting; I needed this once, actually, to insert an ad-hoc section. Would something like an @Rd tag suffice?

–––––––––––––––––––––––––––––––––––––––
Mark Heckmann
Blog: www.markheckmann.de
R-Blog: http://ryouready.wordpress.com





----- End forwarded message -----