[R-pkg-devel] documentation of generic '['
Berri, Stefano
sberri at illumina.com
Wed Mar 9 13:10:15 CET 2016
Hi.
I am having problems with R CMD check around documentation of method "[". I am pretty sure I didn't have this WARNING when I used R-3.0.2. I have tried many things, but I am not sure how to fix it.
$ R CMD check encore
...
* using R version 3.2.3 (2015-12-10)
...
* checking for missing documentation entries ... WARNING
Undocumented S4 methods:
generic '[' and siglist 'encore,ANY,ANY'
All user-level objects in a package (including S4 classes and methods)
should have documentation entries.
See chapter 'Writing R documentation files' in the 'Writing R
Extensions' manual.
...
Everything else is OK, there is an unrelated NOTE we are addressing
##### R CODE ######
setMethod("[", "encore", function(x,i,j,drop){
... code here ...
})
##### DOCUMENTATION #####
\name{encore-class}
\Rdversion{0.1}
\docType{class}
\alias{encore}
\alias{subtraction-class}
\alias{encore-class}
\alias{dConn-class}
\alias{[,encore-method}
... description of the class, no explicit description of method "[" though
##########################
I have tried various things searching around, but I seem to introduce new WARNINGS without removing the one I have.
I have read the "Writing R documentation files", but there is no special description of method "[", and I am struggling to understand what's wrong.
Thank you very much in advance
Stefano
More information about the R-package-devel
mailing list