search

Matt-Brigida / EIAdata

R Wrapper for the Energy Information Administration (EIA) API
16 stars 15 forks source link

Added a tree infrastructure #5

Closed bramtayl closed 6 years ago

bramtayl commented 7 years ago

Also a vignette, and migrated docs over to ROxygen

Matt-Brigida commented 7 years ago

Thanks for your pull request! The additional functionality looks useful. I'll run some checks tonight, and hopefully will be able to merge or comment shortly.

Matt-Brigida commented 7 years ago

I am getting 1 CRAN check error regarding the new documentation format. 

$ R CMD build EIAdata
$ R CMD check --as-cran EIAdata_0.0.4.tar.gz

* checking for missing documentation entries ... WARNING
Undocumented code objects:
  ‘branch’ ‘branch_ID’ ‘branches’ ‘getCatEIA’ ‘getEIA’ ‘leaf’
  ‘leaf_info’ ‘leaves’ ‘trunk’ ‘wngsr’
All user-level objects in a package should have documentation entries.
See chapter ‘Writing R documentation files’ in the ‘Writing R
Extensions’ manual.

Any ideas?

bramtayl commented 7 years ago

Try devtools::document(). It should generate the manual pages using the inline comments.