search

lhenneman / hyspdisp

4 stars 4 forks source link

Not all the functions have Rd. files. #31

Closed schoolAccountMajaG closed 5 years ago

schoolAccountMajaG commented 5 years ago

I can install hyspdisp but when I want to read about the functions using ?name_of_function it shows no documentation. Need to figure out why

schoolAccountMajaG commented 5 years ago

Ok.. I figured it out.

cchoirat commented 5 years ago

Before closing, please document the part you figured out.

schoolAccountMajaG commented 5 years ago

Not all the functions have Rd. files.

cchoirat commented 5 years ago

you mean not all the functions?

and should they?

On Thu, Jun 13, 2019 at 1:16 PM Maja notifications@github.com wrote:

Not all the packages have Rd. files.

— You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub https://github.com/lhenneman/hyspdisp/issues/31?email_source=notifications&email_token=AA73AZPE2ERW5ARMDIA3753P2IT73A5CNFSM4HXX53BKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODXTLTEQ#issuecomment-501660050, or mute the thread https://github.com/notifications/unsubscribe-auth/AA73AZIWRWDEQJFJJHUJORTP2IT73ANCNFSM4HXX53BA .

schoolAccountMajaG commented 5 years ago

Yes! I am sorry. I edited it. Yes, they should!

cchoirat commented 5 years ago

You can decide with @lhenneman which functions matter in the workflow, and document them carefully. You don't have to export all the functions of the package: http://r-pkgs.had.co.nz/namespace.html.

Also a large part of the process can be automated (https://cran.r-project.org/web/packages/roxygen2/vignettes/roxygen2.html):

Roxygen2 dynamically inspects the objects that it’s documenting, so it can automatically add data that you’d otherwise have to write by hand.

cchoirat commented 5 years ago

By the way issue title is a little ambiguous: Not all the packages have Rd. files.