You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Most analyze functions currently require arguments that are not explicitly listed in their arguments. These arguments (as well as optional settings specific to the function) should be exposed to the user so that they know what is required to use the function. This way users are not also required to read the documentation for the associated statistic function when using an analyze function and error messages relating to these arguments are more coherent.
For example, the thresholds argument is required to use count_cumulative but this argument is not listed in the usage section for count_cumulative, only for s_count_cumulative.
This update will also be useful later on when refactoring analyze functions and when statistics functions are moved to the tern.s package.
Most analyze functions currently require arguments that are not explicitly listed in their arguments. These arguments (as well as optional settings specific to the function) should be exposed to the user so that they know what is required to use the function. This way users are not also required to read the documentation for the associated statistic function when using an analyze function and error messages relating to these arguments are more coherent.
For example, the
thresholds
argument is required to usecount_cumulative
but this argument is not listed in the usage section forcount_cumulative
, only fors_count_cumulative
.This update will also be useful later on when refactoring analyze functions and when statistics functions are moved to the tern.s package.
Part of #1130
The text was updated successfully, but these errors were encountered: