improve nomenclature consistency
- 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
idinget_vessel_info()andvesselsin other functions - they're named
idorvesselIdin the API results (selRepoortedInfo$id,combinedSourcesInfo$VesselIDbut there are other fields namedidin the returning datasets that are not vessel IDs likeregistryInfo$id
Possible discussion with the API team as well to avoid solving downstream.
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.
- [x] readd the explanation that ssvid is MMSI in the case of AIS
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"?
Thanks for flagging this, @jflowernet ! I made a correction to USER_SHAPEFILE.
- [x]
idinget_event()should be namedeventID - [x]
idinget_vessel_info$registryInfoshould be namedregistryId
Closing for now but other changes may be necessary.