Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation-related warnings displayed by R CMD check #2

Open
matthuska opened this issue Aug 26, 2014 · 1 comment
Open

Fix documentation-related warnings displayed by R CMD check #2

matthuska opened this issue Aug 26, 2014 · 1 comment

Comments

@matthuska
Copy link
Owner

See below, it's mostly just missing rdoxygen2 docstrings:

* checking for missing documentation entries ... WARNING
Undocumented code objects:
‘exactgevparams’ ‘jaspar’ ‘R_affinity_multi’ ‘R_affinity_sum_multi’
Undocumented data sets:
‘exactgevparams’ ‘jaspar’
All user-level objects in a package should have documentation entries.
See the chapter ‘Writing R documentation files’ in the ‘Writing R
Extensions’ manual.
* checking for code/documentation mismatches ... OK
* checking Rd \usage sections ... WARNING
Undocumented arguments in documentation object 'get.affinity.cutoff'
‘cutoff’
Documented arguments not in \usage in documentation object 'get.affinity.cutoff':
‘pvalue.cutoff’
Documented arguments not in \usage in documentation object 'read.transfac':
‘dir’
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 the chapter ‘Writing R documentation files’ in the ‘Writing R
Extensions’ manual.
* checking Rd contents ... WARNING
Argument items with no description in Rd object 'evaluate.ranking':
‘ranking’ ‘seq.name2matrix’ ‘roc.plot’ ‘add’ ‘col’ ‘predictors’
Argument items with no description in Rd object 'local.paffinity':
‘affnt’ ‘pwm’ ‘seq’ ‘Rmax’ ‘lambda’ ‘pseudo.count’ ‘gc.content’
‘window.size’ ‘window.offset’
@matthuska
Copy link
Owner Author

Fixed them with the exception of these two in e7cf0d9:

* checking Rd contents ... WARNING
Argument items with no description in Rd object 'evaluate.ranking':
  'ranking' 'seq.name2matrix' 'roc.plot' 'add' 'col' 'predictors'

Argument items with no description in Rd object 'local.paffinity':
  'affnt' 'pwm' 'seq' 'Rmax' 'lambda' 'pseudo.count' 'gc.content'
  'window.size' 'window.offset'

@matthiasheinig can you add this documentation sometime? no rush.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant