ropensci / neotoma

Programmatic R interface to the Neotoma Paleoecological Database.
https://docs.ropensci.org/neotoma
Other
30 stars 16 forks source link

Argument for `compile_list()` is `data` but `sample` is used in the code #25

Closed gavinsimpson closed 11 years ago

gavinsimpson commented 11 years ago

R CMD check warns

* checking Rd \usage sections ... WARNING 
Undocumented arguments in documentation object 'compile_list'
  ‘sample’
Documented arguments not in \usage in documentation object 'compile_list':
  ‘data’

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.

A simple fix is to change line 7 in ./R/compile.list.R from

#' @param data A pollen object returned by \code{get_download}.

to

#' @param sample A pollen object returned by \code{get_download}.

But data seems a better name for the object returned by get_download().

Alternatively, the argument could be object which is used regularly in R.