[Rd] package.skeleton.S4

Christophe Genolini cgenolin at u-paris10.fr
Sat Apr 5 17:10:47 CEST 2008


Am I suppose to repport only but, or can I also make some comments?
Well, I guess if I am not suppose to comment, it is easy to ignore them...

Concerning the help file, some other examples might be a good complement 
to the existing one.

--- 8< ------------------
\examples{
require(stats)
## two functions and two "data sets" :
f <- function(x,y) x+y
g <- function(x,y) x-y
d <- data.frame(a=1, b=2)
e <- rnorm(1000)

# using list will create one file for each function
package.skeleton(name="mypkg",list=c("f","g","d","e"))


### Using a file :
sink("myPack2.r")
cat("
    f2 <- function(x,y) x*y
    d2 <- data.frame(a=rnorm(10),b=1:10)
")
sink()

# using code_files will copy the file
package.skeleton(name="mypkg2",code_files="myPack2.r")

### Dealing with S4 :
sink("myPack3.r")
cat("
    setClass('A',representation(x='numeric'))
    
setMethod('print','A',function(x){cat('AAA',x at x,'AAA');return(invisible())})
")
sink()
package.skeleton(name="mypkg3",code_files="myPack3.r")

### function or variable starting with . (dot) are hidden (see NAMESPACE)
.h <- function(x,y) x/y
package.skeleton(name="mypkg4",list=c("f","g","d","e",".h"))
}
--- 8< ------------------


Concerning the package construction:
after running package.skeleton, we (low level user) migth expect R CMD 
check and R CMD build to compile
It is not the case because of an error and some warnings.

Here is the error :
    Examples failed

May be some '#' can be put in the example code to prevent it from failling?

The warnings are :
    ~kwd1 is not a keyword
    duplicated alias for myMethod,AA-method
    missing link()
    Unaccounted top-level text

    for french people, some "é" and "è" provoque warnings as well.


Christophe



More information about the R-devel mailing list