search

BiologicalRecordsCentre / BRCindicators

An R package for creating indicators from trends data
4 stars 11 forks source link

Undocumented code object #54

Open AugustT opened 4 years ago

AugustT commented 4 years ago

Checks is currently unhappy that these functions are not documented:

* checking for missing documentation entries ... WARNING
Undocumented code objects:
  ‘plot_growthrates’ ‘plot_species’ ‘plot_spgrowthrates’
  ‘simulate_indicator’ ‘wrap_plot’
DylanCarbone commented 2 months ago

Hi @AugustT,

This relates to our discussion in our last meeting. The functions had export tags but no other documentation. I removed the export tags, assuming they were helper functions, however this may have been incorrect for some. Regarding each:

plot_growthrates, plot_spgrowthrates and wrap_plot: plot_growthrates and plot_spgrowthrates seem to be helper functions for wrap_plot. But the wrap_plot function is not used in the vignette.

plot_species: This is not nested in any function, and is not used in the vignette.

simulate_indicator: Also not nested or used in the vignette. It produces a dataset but I cannot tell to which function it should be input into.

We can discuss this in our next meeting.