EOGrady21 / vprr

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

vpr_ctd_read() - documentation #48

Closed kevinsorochan closed 11 months ago

kevinsorochan commented 1 year ago

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

I'm always frustrated when... I see an argument described as a list in the documentation when the object is not of class list but of class chr

In this case the argument, col_list is actually specified as a chr in vpr_ctd_read(). In the documentation, col_list is described as "list of CTD data column names", when in fact it is a chr vector with elements for each column name.

Describe the solution you'd like Changes the name of the argument such that "list" is not mentioned. E.g., something like ctd_colnames Change the description such that the word "list" is not mentioned, E.g., something like a vector specifying ctd column names in ctd .dat file