ramhiser / sparsediscrim

Sparse and Regularized Discriminant Analysis in R
Other
15 stars 5 forks source link

Fix R CMD CHECK notes and warnings #35

Closed ramhiser closed 8 years ago

ramhiser commented 8 years ago

In order to update the package on CRAN, need to fix the following notes and warnings from devtools::check().

> check()
 Updating sparsediscrim documentation
 Loading sparsediscrim
...
Missing link or links in documentation object 'hdrda_cv.Rd':
   ‘ggplot2’

 See section 'Cross-references' in the 'Writing R Extensions' manual.

 * checking for missing documentation entries ... OK
 * checking for code/documentation mismatches ... OK
 * checking Rd \usage sections ... WARNING
 Duplicated \argument entries in documentation object 'dlda':
   ‘x’ ‘...’

 Undocumented arguments in documentation object 'dmvnorm_diag'
   ‘sigma’
 Documented arguments not in \usage in documentation object 'dmvnorm_diag':
   ‘cov’

 Duplicated \argument entries in documentation object 'dqda':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'hdrda':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'hdrda_cv':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'lda_pseudo':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'lda_schafer':
   ‘x’ ‘...’ ‘...’

 Duplicated \argument entries in documentation object 'lda_thomaz':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'mdeb':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'mdmeb':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'mdmp':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'sdlda':
   ‘x’ ‘...’

Duplicated \argument entries in documentation object 'sdqda':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'smdlda':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'smdqda':
   ‘x’ ‘...’

 Functions with \usage entries need to have the appropriate \alias
 entries, and all their arguments documented.
 The \usage entries must correspond to syntactically valid R code.
 See chapter ‘Writing R documentation files’ in the ‘Writing R
 Extensions’ manual.
 * checking Rd contents ... OK
 * checking for unstated dependencies in examples ... OK
 * checking examples ... OK
 * DONE

 Status: 2 WARNINGs, 1 NOTE
 See
   ‘/private/var/folders/7d/pcy077cj44n0cs351w0mv6q40000gn/T/Rtmp9xXf5N/sparsediscrim.Rcheck/00check.log’
 for details.

 R CMD check results
 0 errors | 2 warnings | 1 note
ramhiser commented 8 years ago

After fixing plot.hdrda_cv docs, remaining devtools::check() results to fix:

* checking Rd \usage sections ... WARNING
 Duplicated \argument entries in documentation object 'dlda':
   ‘x’ ‘...’

 Undocumented arguments in documentation object 'dmvnorm_diag'
   ‘sigma’
 Documented arguments not in \usage in documentation object 'dmvnorm_diag':
   ‘cov’

 Duplicated \argument entries in documentation object 'dqda':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'hdrda':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'hdrda_cv':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'lda_pseudo':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'lda_schafer':
   ‘x’ ‘...’ ‘...’

 Duplicated \argument entries in documentation object 'lda_thomaz':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'mdeb':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'mdmeb':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'mdmp':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'sdlda':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'sdqda':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'smdlda':
   ‘x’ ‘...’

 Duplicated \argument entries in documentation object 'smdqda':
   ‘x’ ‘...’

Functions with \usage entries need to have the appropriate \alias
 entries, and all their arguments documented.
 The \usage entries must correspond to syntactically valid R code.
 See chapter ‘Writing R documentation files’ in the ‘Writing R
 Extensions’ manual.
 * checking Rd contents ... OK
 * checking for unstated dependencies in examples ... OK
 * checking examples ... OK
 * DONE

 Status: 1 WARNING
 See
   ‘/private/var/folders/7d/pcy077cj44n0cs351w0mv6q40000gn/T/Rtmpr2JLnU/sparsediscrim.Rcheck/00check.log’
 for details.

 R CMD check results
 0 errors | 1 warning  | 0 notes