Encapsulate fgeo: Overview
Closed this issue · 0 comments
maurolepore commented
Expose functions via fgeo. The benefit is for the userst to access all objects with fgeo::object
, and for the developers to manage the location of object
freely, withouth disrupting users (via fgeo::object <- module::object`).
Modules:
- fgeo.tool
- fgeo.analyze
- fgeo.x
- fgeo
Encapsulate module
In module
- Do:
- ensure to export the minimum possible
- ensure to not document internal functions by using
#' @noRd
. - don't use
#' @keywords internal
if using @nord. - pay particular attention to generics and methods.
- use appropriate
@family
.
In fgeo
- Create R/module-reexport.R
For each function
- Reexport function and documentation
- Remove package from
fgeo_on_attach()