All,
I get the following warning using Roxygen2
* checking for missing documentation entries ... WARNING
Undocumented S4 classes:
‘MortgageEffectiveMeasures’
The code to create and document the class is below
#' An S4 class MortgageEffectiveMeasures
#'
#' A class of mortgage effective
On 24/07/2016 1:35 PM, Glenn Schultz wrote:
All,
I get the following warning using Roxygen2
* checking for missing documentation entries ... WARNING
Undocumented S4 classes:
‘MortgageEffectiveMeasures’
The code to create and document the class is below
#' An S4 class MortgageEffectiveMeas
Did you call `devtools::document()` before building and checking your
package? Everything looks fine to me with your test example. You
should also double-check that you have up-to-date versions of the
devtools and roxygen2 packages.
It's also worth knowing that nowadays you can generally just use
Duncan is correct the class is not documented but the generics, methods, and
constructor functions are documented. Kevin, I updated both devtools and
Roxygen2 with the same issue. I am using R Studio. I tried refactoring around
some functions and files whose names were close in the event that
If you're using RStudio, have you enabled 'Generate documentation with
Roxygen' in your Project Options?
Can you confirm whether manually invoking 'devtools::document()'
creates a file at 'man/MortgageEffectiveMeasures-class.Rd', with the
expected documentation?
Everything looks fine for me with
check on Generate documentation with Oxygen
check devtools::document() does not create the
man/MortgageEffectiveMeasures-class.Rd
I can share my sources but I am not sure the base way to go about. It is on
github in a private repo which I can provide access or ssh key
Glenn
> On Jul 24, 20
roxygen2 can be fragile when there are mistakes in preceding
roxygen2 documentation blocks, or conflicting documentation blocks
elsewhere in a package, and, if I remember correctly, extraneous empty
lines. A lack of verbose options or logging makes debugging roxygen2 errors
tricky sometimes. Try pu
