gfwr icon indicating copy to clipboard operation
gfwr copied to clipboard

improve nomenclature consistency

Open AndreaSanchezTapia opened this issue 1 year ago • 4 comments

  • Vessel IDs, vessel IDs, vesselID (in the table), and VesselID (in the documentation) are spelled in many ways in different places.
  • the parameters are called as id in get_vessel_info() and vessels in other functions
  • they're named id or vesselId in the API results (selRepoortedInfo$id, combinedSourcesInfo$VesselID but there are other fields named id in the returning datasets that are not vessel IDs like registryInfo$id

Possible discussion with the API team as well to avoid solving downstream.

AndreaSanchezTapia avatar Jun 27 '24 01:06 AndreaSanchezTapia

The tinyest change to avoid a long explanation is renaming selfReportedInfo$id to selfReportedInfo$vesselId in the results. No change to parameters or API calls, only readme and vignette results processing.

AndreaSanchezTapia avatar Jun 29 '24 17:06 AndreaSanchezTapia

  • [x] readd the explanation that ssvid is MMSI in the case of AIS

AndreaSanchezTapia avatar Jul 01 '24 04:07 AndreaSanchezTapia

Hi. Hope you don't mind me jumping in, but I had a thought about argument naming! I notice in the latest version of gfwr, get_raster() has had some changes, one of which is that the user specified region should be an sf object (great enhancement, thanks!). Given this change, wouldn't it make sense to use region_source = "user_polygon", or something similar, rather than "user_json"?

jflowernet avatar Jul 11 '24 03:07 jflowernet

Thanks for flagging this, @jflowernet ! I made a correction to USER_SHAPEFILE.

AndreaSanchezTapia avatar Jul 22 '24 23:07 AndreaSanchezTapia

  • [x] id in get_event() should be named eventID
  • [x] id in get_vessel_info$registryInfo should be named registryId

AndreaSanchezTapia avatar Nov 29 '24 20:11 AndreaSanchezTapia

Closing for now but other changes may be necessary.

AndreaSanchezTapia avatar Dec 05 '24 20:12 AndreaSanchezTapia