[inlinedocs] Package inlinedocs_1.6.tar.gz did not pass R CMD check
Uwe.Ligges at R-Project.org
Uwe.Ligges at R-Project.org
Sun Oct 16 17:00:14 CEST 2011
Dear package maintainer,
this notification has been generated automatically.
Your package inlinedocs_1.6.tar.gz did *not* pass 'R CMD check' on
Windows and will be omitted from the corresponding CRAN directory
(CRAN/bin/windows/contrib/2.14/).
Please check the attached log-file and consider to resubmit a version
with increased version number that passes R CMD check on Windows.
Please note that we are talking about R-2.14.0 alpha/beta/rc
(but not the current R-2.13.2, the current release version of R).
R-2.14.0 will be released on October 31.
Please consider to submit a fixed version without any ERROR or WARNING until release.
For details (and for results on other platforms) see
http://cran.r-project.org/web/checks/check_summary.html
A description on how to update packages for specific R-2.14.0 related changes is
available at http://developer.r-project.org/214update.txt
R version 2.14.0 alpha (2011-10-13 r57240)
All the best,
Uwe Ligges
(Maintainer of binary packages for Windows)
-------------- next part --------------
* using log directory 'd:/Rcompile/CRANpkg/local/2.14/inlinedocs.Rcheck'
* using R version 2.14.0 alpha (2011-10-13 r57240)
* using platform: i386-pc-mingw32 (32-bit)
* using session charset: ISO8859-1
* checking for file 'inlinedocs/DESCRIPTION' ... OK
* checking extension type ... Package
* this is package 'inlinedocs' version '1.6'
* checking package namespace information ... OK
* checking package dependencies ... OK
* checking if this is a source package ... OK
* checking if there is a namespace ... OK
* checking whether package 'inlinedocs' can be installed ... OK
* checking installed package size ... OK
* checking package directory ... OK
* checking for portable file names ... OK
* checking DESCRIPTION meta-information ... OK
* checking top-level files ... OK
* checking index information ... OK
* checking package subdirectories ... OK
* checking R files for non-ASCII characters ... OK
* checking R files for syntax errors ... OK
* checking whether the package can be loaded ... OK
* checking whether the package can be loaded with stated dependencies ... OK
* checking whether the package can be unloaded cleanly ... OK
* checking whether the namespace can be loaded with stated dependencies ... OK
* checking whether the namespace can be unloaded cleanly ... OK
* checking for unstated dependencies in R code ... OK
* checking S3 generic/method consistency ... OK
* checking replacement functions ... OK
* checking foreign function calls ... OK
* checking R code for possible problems ... OK
* checking Rd files ... OK
* checking Rd metadata ... OK
* checking Rd cross-references ... OK
* checking for missing documentation entries ... OK
* checking for code/documentation mismatches ... OK
* checking Rd \usage sections ... OK
* checking Rd contents ... OK
* checking for unstated dependencies in examples ... OK
* checking examples ... ERROR
Running examples in 'inlinedocs-Ex.R' failed
The error most likely occurred in:
> ### Name: package.skeleton.dx
> ### Title: Package skeleton deluxe
> ### Aliases: package.skeleton.dx 'inlinedocs '
>
> ### ** Examples
>
> library(inlinedocs)
>
> owd <- setwd(tempdir())
>
> ## get the path to the silly example package that is provided with
> ## package inlinedocs
> testPackagePath=file.path( system.file(package="inlinedocs"),"silly" )
> ## copy example project to the current unlocked workspace that can
> ## be modified
> file.copy(testPackagePath,".",recursive=TRUE)
[1] TRUE
>
> ## generate documentation rd-Files for this package
> package.skeleton.dx("silly")
extra.code.docs prefixed.lines extract.xxx.chunks title.from.firstline examples.from.testfile definition.from.source edit.package.file author.from.description erase.format title.from.name examples.in.attr collapse tag.s3methods
Creating directories ...
Creating DESCRIPTION ...
Creating NAMESPACE ...
Creating Read-and-delete-me ...
Copying code files ...
Making help files ...
Done.
Further steps are described in './silly/Read-and-delete-me'.
Modifying files automatically generated by package.skeleton:
silly.example: definition author format title
Silly-class: details item{forwards} item{reverse} item{crashes} description title section{Objects from the Class} seealso alias author format
silly-package: title description tabular{ll} author format
>
> ## display source file and the generated Rd file
> file.show( c(file.path("silly","R","silly.R"),
+ file.path("silly","man","silly.example.Rd") ),
+ header=c("source","rd") )
silly.example <- function
### this function does nothing in particular and does it very well
(
##title<<Simple function arguments
first, ##<< the first argument with a multi-line description
## which I really have to put here rather than explaining in the details.
second= ##<< the second argument with a list default value
## and descriptions of each of the elements
##describe<<
list(this="that", ##<< whichness
the="other", ##<< of the
rhubarb="stew", ##<< why
foo="bar"),
##end<<
third ##<< an argument that does nothing
)
{
##description<<why should I add to description?
##details<<
## if second is TRUE then first is returned
if ( second ){
##alias<<Long silly alias
res <- first
} else {
##details<<
## if second is not TRUE then a list is returned
##describe<<The contents of the list are:
res <- list(x=7, ##<< x coordinate
z= ##<< z describes everything else
##describe<<
list(colour=green, ##<< colour of line
width=2), ##<< width of line
##end<<
## and this line should get into documentation for z
y=10)##<< y coordinate
}
##note<< a note
##references<< a reference
##seealso<< \code{\link{Silly-class}}
##keyword<<documentation utilities
invisible(res)
### invisible something not unrelated to first
}
setClass("Silly", # S4 classes can be documented as well
### The Silly class does nothing much either
##details<< Put what you like in documentation details,
## but ideally reference construction methods.
representation(forwards="function", ##<< forward operation
reverse="function", ##<< how to go backward
crashes="integer") ##<< how many crashes
) ##<< this comment is ignored as it is outside setClass expression
## creates "show" generic function. Documentation of this not yet supported.
##setMethod("show","Silly",function(object){cat("crashed ",object at crashes," times\n")})
\name{silly.example}
\alias{silly.example}
\title{silly example}
\usage{
silly.example(first, second = list(this = "that", the = "other", rhubarb = "stew", foo = "bar"), third)
}
\arguments{
\item{first}{
}
\item{second}{
}
\item{third}{
}
}
\author{Keith Ponting <k.ponting at aurix.com>}
>
> ## check the package to see if generated documentation passes
> ## without WARNINGs
> cmd <- sprintf("%s CMD check silly",file.path(R.home("bin"), "R"))
> print(cmd)
[1] "d:/Rcompile/recent/R/bin/i386/R CMD check silly"
> checkLines <- system(cmd,intern=TRUE)
> warnLines <- grep("WARNING",checkLines,value=TRUE)
> if(length(warnLines)>0){
+ print(warnLines)
+ stop("WARNING encountered in package check!")
+ }
[1] "* checking Rd files ... WARNING" "WARNING: There was 1 warning, see"
Error: WARNING encountered in package check!
Execution halted
More information about the Inlinedocs-support
mailing list