EOGrady21 / vprr

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

vpr_ctd_ymd documentation #66

Open kevinsorochan opened 2 months ago

kevinsorochan commented 2 months ago

Suggest change to description of function in documentation:

Current description:

Calculate and record calendar dates for vpr data from day-of-year, hour, and time (in milliseconds) info. Will also add 'time_hr' parameter if not already present.

Suggested description:

Obtain columns for date and time (i.e., column "ymdhms") and time in hours (i.e., column time_hr) for each row in VPR data frame by utilizing day-of-year, hour, and millisecond outputs from VPR data output.

kevinsorochan commented 2 months ago

The value description should also be changed

Current text:

a VPR data frame with complete date/time information in a new row named 'ymdhms'

Suggested text:

A VPR data frame with columns for date and time (i.e., column 'ymdhms') and hour (i.e., column time_hr)

EOGrady21 commented 2 months ago

This looks good to me, you are welcome to make these documentation changes directly on main. It should not interfere with any tests or functionality.

kevinsorochan commented 2 months ago

I think this has now been resolved