search

mcsiple / mmrefpoints

A package for simulating marine mammal abundance and calculating reference points.
Other
3 stars 5 forks source link

Think about what you want exported objects to be #45

Closed ChristineStawitz-NOAA closed 3 years ago

ChristineStawitz-NOAA commented 3 years ago

I believe you are currently exporting all objects when you really only want to export functions or datasets you expect to be useful/reusable to those downloading your package.

I created a checklist below for reference so you can check them off as you remove from exports! One easy way to do this would be to go through the .Rd files in your man/ folder and remove anything that does not have a corresponding documentation file as you seem to have documentation for all the functions you want to export.

mcsiple commented 3 years ago

I don't know exactly where it happened, but after making several changes to the NAMESPACE to simplify dependencies, etc, I don't have all of these in the exports anymore:

> getNamespaceExports("mmrefpoints")
 [1] "plot_bycatch_guesses" "run_app"              "abund_rel_vec"        "get_f"                "add_trans"           
 [6] "dynamics"             "get_mnpl"             "find_msyr"            "plot_pinnipeds"       "npr"                 
[11] "plot_yield_curve"     "get_rf"               "calc_z"               "get_dz"               "prob_rebuilt_goal"   
[16] "ce"                   "inv_logit"            "rebuild_by_x"         "plot_proj"            "pop_vs_yield"        
[21] "projections"          "make_ptable"          "multiplot_proj"       "logit"                "abund_rel"           
[26] "getfecmax"            "get_diff"             "ggradar"

I am going to mark this as closed since these are all functions included in the package -- but I wish I had gotten to use this checklist because I love checklists.