ices-tools-dev / RDBEScore

Provides functions to work with the Regional Database & Estimation System (RDBES)
https://ices-tools-dev.github.io/RDBEScore/
GNU General Public License v3.0
0 stars 4 forks source link

Remove `@export` from functions which don't need to be public #168

Closed nicholascarey closed 1 year ago

nicholascarey commented 1 year ago

When you do this add @keywords internal to the roxygen tags, which will mean the function and help documentation will not appear in the index (though i think you need to delete the man folder and run roxygen again to rebuild the documentation or it does not get removed).

nicholascarey commented 1 year ago

Smaller utility functions could also go in the utils.R file which will help keep the folder tidier. They can also go in other .R files - e.g. if an internal function is used in only one exported function it's common to just put it at the bottom of the exported function script.

Can also group related functions in a single file like I have done with utils.R. Basically as long as they are in the R folder somewhere they will work fine.

rix133 commented 1 year ago

I think most obsolete functions are now removed but should any of those also be removed from exports (not used in vignettes currently):

I think if a function is not used in a vignette it should not be exported but the vignettes are currently incomplete #163

rix133 commented 1 year ago

we can keep it as is