Skip to content

Commit

Permalink
CRAN submission feedback: Don't run examples
Browse files Browse the repository at this point in the history
  • Loading branch information
spoltier committed Feb 12, 2021
1 parent d0df814 commit 0023b0c
Show file tree
Hide file tree
Showing 51 changed files with 111 additions and 10 deletions.
21 changes: 11 additions & 10 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
This is a resubmission of XLConnect 1.0.2 to fix obsolete URLs in the package documentation.
This is a resubmission of XLConnect 1.0.2 to fix NOTEs in the previous submission.

# Test Environments

* Ubuntu 18.04 on Github Actions
Expand All @@ -18,24 +19,24 @@ There were 2 NOTEs:

Justification: XLConnect uses a java component which we maintain in a separate project, as well as Apache POI 4.1.x and its dependencies. At install time, the presence of these dependencies in the correct version is checked; if missing, they are downloaded into XLConnect's installation directory. Apache POI 4.1.x is not yet available from major distributions' package managers at the time of writing. In addition, the full ooxml-schemas-1.4.jar is required, which is not distributed via package managers. See https://poi.apache.org/help/faq.html#faq-N10109 for more information.

> checking CRAN incoming feasibility ... NOTE
Maintainer: ‘Martin Studer <[email protected]>
Maintainer: ‘Martin Studer <[email protected]>’

Found the following (possibly) invalid URLs:
URL: https://depsy.org/package/r/XLConnect
From: README.md
Status: Error
Message: libcurl error code 51:
SSL: no alternative certificate subject name matches target host name 'depsy.org'
(Status without verification: OK)
URL: https://www.ozgrid.com/Excel/CustomFormats.htm
From: man/setDataFormat-methods.Rd
man/setDataFormatForType-methods.Rd
Status: 301
Message: Moved Permanently

Justification: the linked website seems to uses cloudflare DDoS protection, which results in a redirect when accessing the URL.

In addition, there was a NOTE on the Debian machine used by CRAN to run tests.

> Found the following files/directories:
‘calibre_5.10.1_tmp_2jgz_y1p’ ‘calibre_5.10.1_tmp_qry3rapb’
Justification: the first linked website has an invalid certificate, the other seems to uses cloudflare DDoS protection,
which results in a redirect when accessing the URL.

This seems unique to that machine and already appeared when submitting the previous version.
# Downstream dependencies

_revdepcheck_ found 10 downstream dependencies; they were all checked successfully.
2 changes: 2 additions & 0 deletions man/aref.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link{idx2cref}}, \code{\link{col2idx}}, \code{\link{idx2col}}
}
\examples{
\dontrun{
aref("A1", dim(mtcars))
aref(c(1, 1), dim(mtcars))
}
}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/aref2idx.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link{idx2cref}}, \code{\link{col2idx}}, \code{\link{idx2col}}
}
\examples{
\dontrun{
aref2idx(c("A1:B6", "B6:C17"))
}
}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/clearNamedRegion-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link[=clearSheet-methods]{clearSheet}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of
# package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx",
Expand All @@ -58,6 +59,7 @@ clearNamedRegion(wb, name = "mtcars")
# to the size/area of the data
writeNamedRegion(wb, data = data, name = "mtcars",
header = TRUE)
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/clearRange-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link[=clearSheet-methods]{clearSheet}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of
# package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx",
Expand All @@ -65,5 +66,6 @@ clearRange(wb, sheet = "mtcars",
clearRangeFromReference(wb, reference = c("mtcars!A5:D6",
"mtcars!G5:I7"))
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/clearRangeFromReference-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link[=clearSheet-methods]{clearSheet}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of
# package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx",
Expand All @@ -45,5 +46,6 @@ wb <- loadWorkbook(demoExcelFile)
clearRangeFromReference(wb, reference = c("mtcars!A5:D6",
"mtcars!G5:I7"))
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/clearSheet-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link[=clearRangeFromReference-methods]{clearRangeFromReference}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of
# package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx",
Expand All @@ -51,5 +52,6 @@ clearSheet(wb, sheet = c("mtcars", "mtcars2"))
# Clear 3rd worksheet
clearSheet(wb, sheet = 3)
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/cloneSheet-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link[=getSheets-methods]{getSheets}}, \code{\link[=existsSheet-methods]{existsSheet}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

Expand All @@ -40,5 +41,6 @@ wb <- loadWorkbook(demoExcelFile)
# Clone the 'mtcars' worksheet and assign it the name 'mtcars cloned'
cloneSheet(wb, sheet = "mtcars", name = "mtcars cloned")
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/col2idx.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link{idx2aref}}, \code{\link{aref2idx}}, \code{\link{aref}}
}
\examples{
\dontrun{
col2idx(c("A", "BTG"))
}
}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/cref2idx.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link{idx2aref}}, \code{\link{aref2idx}}, \code{\link{aref}}
}
\examples{
\dontrun{
cref2idx(c("$A$20", "B18"))
}
}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/existsName-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link[=writeNamedRegion-methods]{writeNamedRegion}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
mtcarsFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

Expand All @@ -43,5 +44,6 @@ wb <- loadWorkbook(mtcarsFile)
# (should return TRUE since the name is defined as 'mtcars!$A$1:$K$33')
existsName(wb, name = "mtcars")
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/existsSheet-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link[=getSheets-methods]{getSheets}}, \code{\link[=cloneSheet-methods]{cloneSheet}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

Expand All @@ -42,5 +43,6 @@ wb <- loadWorkbook(demoExcelFile)
# Check for existence of a worksheet called 'mtcars'
existsSheet(wb, "mtcars")
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/extractSheetName.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Martin Studer\cr
Mirai Solutions GmbH \url{https://mirai-solutions.ch}
}
\examples{
\dontrun{
extractSheetName(c("MySheet!$A$1", "'My Sheet'!$A$1", "'My!Sheet'!$A$1"))
}
}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/getActiveSheetIndex-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\linkS4class{workbook}}, \code{\link[=getActiveSheetName-methods]{getActiveSheetName}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

Expand All @@ -32,5 +33,6 @@ wb <- loadWorkbook(demoExcelFile)
# Query the active sheet index
activeSheet <- getActiveSheetIndex(wb)
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/getActiveSheetName-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\linkS4class{workbook}}, \code{\link[=getActiveSheetIndex-methods]{getActiveSheetIndex}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

Expand All @@ -32,5 +33,6 @@ wb <- loadWorkbook(demoExcelFile)
# Query the active sheet name
activeSheet <- getActiveSheetName(wb)
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/getBoundingBox-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\linkS4class{workbook}}
}
\examples{
\dontrun{
# multiregion xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/multiregion.xlsx", package = "XLConnect")

Expand All @@ -61,5 +62,6 @@ print(getBoundingBox(wb, sheet="SecondSheet"))
# Query bounding box for the first sheet, selecting the columns from 5 to 8
print(getBoundingBox(wb, sheet="FirstSheet", startCol=5, endCol=8))
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/getDefinedNames-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link[=writeNamedRegion-methods]{writeNamedRegion}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
mtcarsFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

Expand All @@ -38,5 +39,6 @@ wb <- loadWorkbook(mtcarsFile)
# Retrieve defined names with valid references
getDefinedNames(wb)
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/getForceFormulaRecalculation-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link[=setForceFormulaRecalculation-methods]{setForceFormulaRecalculation}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

Expand All @@ -39,5 +40,6 @@ wb <- loadWorkbook(demoExcelFile)
# Ask whether Excel will automatically recalculate formulas on sheet mtcars
print(getForceFormulaRecalculation(wb, sheet = "mtcars"))
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/getLastColumn-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\linkS4class{workbook}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

Expand All @@ -44,5 +45,6 @@ getLastColumn(wb, "mtcars2")
# Query the last row of the 'mtcars3' worksheet
getLastColumn(wb, "mtcars3")
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/getLastRow-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\linkS4class{workbook}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

Expand All @@ -44,5 +45,6 @@ getLastRow(wb, "mtcars2")
# Query the last row of the 'mtcars3' worksheet
getLastRow(wb, "mtcars3")
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/getReferenceCoordinates-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link[=removeName-methods]{removeName}}, \code{\link[=getReferenceFormula-methods]{getReferenceFormula}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

Expand All @@ -38,5 +39,6 @@ wb <- loadWorkbook(demoExcelFile)
# Query reference coordinate for name 'mtcars'
print(getReferenceCoordinatesForName(wb, name = "mtcars"))
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/getReferenceCoordinatesForName-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link[=getReferenceCoordinatesForTable-methods]{getReferenceCoordinatesForTable}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

Expand All @@ -36,5 +37,6 @@ wb <- loadWorkbook(demoExcelFile)
# Query reference coordinate for name 'mtcars'
print(getReferenceCoordinatesForName(wb, name = "mtcars"))
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/getReferenceCoordinatesForTable-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link[=getReferenceCoordinatesForName-methods]{getReferenceCoordinatesForName}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

Expand All @@ -41,5 +42,6 @@ wb <- loadWorkbook(demoExcelFile)
print(getReferenceCoordinatesForTable(wb, sheet = "mtcars_table",
table = "MtcarsTable"))
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/getReferenceFormula-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link[=removeName-methods]{removeName}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

Expand All @@ -35,5 +36,6 @@ wb <- loadWorkbook(demoExcelFile)
# Query reference formula for name 'mtcars'
print(getReferenceFormula(wb, name = "mtcars"))
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/getSheetPos-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link[=getSheets-methods]{getSheets}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

Expand All @@ -38,5 +39,6 @@ wb <- loadWorkbook(demoExcelFile)
# 'mtcars' and 'NotThere' (which actually does not exist)
print(getSheetPos(wb, sheet = c("mtcars2", "mtcars3", "mtcars", "NotThere")))
}
}
\keyword{methods}
\keyword{utilities}
2 changes: 2 additions & 0 deletions man/getSheets-methods.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Mirai Solutions GmbH \url{https://mirai-solutions.ch}
\code{\link[=getSheetPos-methods]{getSheetPos}}, \code{\link[=setSheetPos-methods]{setSheetPos}}
}
\examples{
\dontrun{
# mtcars xlsx file from demoFiles subfolder of package XLConnect
demoExcelFile <- system.file("demoFiles/mtcars.xlsx", package = "XLConnect")

Expand All @@ -33,5 +34,6 @@ wb <- loadWorkbook(demoExcelFile)
# Query available worksheets
sheets <- getSheets(wb)
}
}
\keyword{methods}
\keyword{utilities}
Loading

0 comments on commit 0023b0c

Please sign in to comment.