Roxygen2 introduces \n to default parameter value. Causes Codoc mismatches
Question
I'm having the opposite issues of this post. It seems that roxygen is introducing \n
into my default parameter values which causes R CMD check to WARN
Here's my function definition:
WriteToExcel <- function( filePath = stop( "filePath must be specified" ) , worksheet = stop( "worksheet must be specified" ) , toWrite = stop( "toWrite must be specified" ) , rownames = FALSE )
{
...
}
And here's the warning:
Codoc mismatches from documentation object 'WriteToExcel':
WriteToExcel
Code: function(filePath = stop("filePath must be specified"),
worksheet = stop("worksheet must be specified"),
toWrite = stop("toWrite must be specified"), rownames
= FALSE)
Docs: function(filePath = stop("filePath must be\n specified"),
worksheet = stop("worksheet must be\n specified"),
toWrite = stop("toWrite must be specified"), rownames
= FALSE)
Mismatches in argument default values:
Name: 'filePath' Code: stop("filePath must be specified") Docs: stop("filePath must be\n specif
ied")
Name: 'worksheet' Code: stop("worksheet must be specified") Docs: stop("worksheet must be\n spe
cified")
Am I missing something here?
Solution
It seems this is a known issue. Closing out this question.
Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow