search

EOGrady21 / vprr

Video Plankton Recorder Data Processing
https://eogrady21.github.io/vprr/
Other
2 stars 1 forks source link

vpr_autoid_copy() - improve documentation #43

Closed kevinsorochan closed 11 months ago

kevinsorochan commented 1 year ago

Is your feature request related to a problem? Please describe. Yes:

(1) The function documentation should not reference "visual plankton" or "VP"

(2) Without context, the user will be confused about what to enter for "classifier_type" and "classifier_name" arguments

(3) The description of the "basepath" argument needs improvement

Describe the solution you'd like (1) References to visual plankton should be changed to "image classifier" or equivalent

(2) Improve the description of these arguments - for example explain that these arguments are used to identify classifier name and type from the name of the autoid file, correct? It should also be stated that these arguments are "optional"

(3) The basepath should be described as "file path specifying autoid folder where the classification and morphometric data for each roi is stored" (or equivalent)... perhaps consider using a more specific argument name for basepath (e.g., autoid_path)?

EOGrady21 commented 11 months ago

This was updated along with Issue #50