search

bcgov / rems

An R package to access data from British Columbia's Environmental Monitoring System
Apache License 2.0
19 stars 5 forks source link

Add package-level documentation #27

Closed stephhazlitt closed 6 years ago

stephhazlitt commented 6 years ago

It would be useful of users could get the list of functions using ?rems in the console.

boshek commented 6 years ago

I could be wrong, but I think the convention is that ?package-name provide an overview of the package and then help(package = "rems") provides a list of functions.

stephhazlitt commented 6 years ago

I am sure you are correct. At this time ?rems brings up nothing -- and many users use this path to get to the list of functions via the index. I am not sure what the overview documentation is called, but I think it would be useful to add to rems.

ateucher commented 6 years ago

yeah, I almost never use help(package = "rems") - can never remember the syntax. ?rems is much nicer

ateucher commented 6 years ago

and behold usethis::use_package_doc()