search

pfmc-assessments / PacFIN.Utilities

R code to manipulate data from the PacFIN database for assessments
http://pfmc-assessments.github.io/PacFIN.Utilities
Other
7 stars 2 forks source link

work towards having man pages for all functions? #2

Closed iantaylor-NOAA closed 7 years ago

iantaylor-NOAA commented 7 years ago

It can be very handy to get man (help) pages by typing something like ?combineCALCOM Currently about half of the functions have comments at the top which can be converted into man pages using the devtools::document function, which relies on the roxygen2 package but not all of these are complete. The "Individual Function Descriptions" section of the Vignette could be easily converted into this format (and I'm happy to help do so).

andi-stephens-NOAA commented 7 years ago

Yes, I'm working on getting the rest of the functions documented... I'm at a GMT meeting the rest of this week.

--A.

On Wed, Oct 5, 2016 at 10:42 AM, Ian Taylor notifications@github.com wrote:

It can be very handy to get man (help) pages by typing something like ?combineCALCOM Currently about half of the functions have comments at the top which can be converted into man pages using the devtools::document function, which relies on the roxygen2 package but not all of these are complete. The "Individual Function Descriptions" section of the Vignette could be easily converted into this format (and I'm happy to help do so).

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/nwfsc-assess/PacFIN.Utilities/issues/2, or mute the thread https://github.com/notifications/unsubscribe-auth/AKdMBjwOQL9nTlRbFO04RuOYykiBYQJaks5qw-GdgaJpZM4KPFsW .

iantaylor-NOAA commented 7 years ago

The man pages are great, thank you. It's really convenient to run commands like

?PacFIN.Utilities
?cleanPacFIN

instead of having to look through a manual.