Document `trans_fn` parameters

tristan-sebens / metl

An R package developed by and for the AFSC MESA group for extracting and standardizing data from telemetry tags.

GNU General Public License v3.0

0 stars 0 forks source link

Document `trans_fn` parameters #85

Closed tristan-sebens closed 2 months ago

tristan-sebens commented 4 months ago

The trans_fn attribute of each Field object gets called by the DataMap during the transform method call, and gets passed a number of values, including the vector of current values in the field, the complete dataframe, the input/output FieldMap objects, etc.

There is currently no documentation regarding what values are passed to the trans_fn for use by the developer. There should be.

tristan-sebens commented 2 months ago

Added documentation to the README