Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve nomenclature consistency #146

Open
AndreaSanchezTapia opened this issue Jun 27, 2024 · 5 comments
Open

improve nomenclature consistency #146

AndreaSanchezTapia opened this issue Jun 27, 2024 · 5 comments
Labels
API-side documentation Improvements or additions to documentation enhancement New feature or request

Comments

@AndreaSanchezTapia
Copy link
Member

AndreaSanchezTapia commented Jun 27, 2024

Vessel ID
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 (selReportedInfo$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 AndreaSanchezTapia added documentation Improvements or additions to documentation enhancement New feature or request API-side labels Jun 27, 2024
@AndreaSanchezTapia
Copy link
Member Author

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 added a commit that referenced this issue Jun 29, 2024
…`) and adding error messages for vesselId search. renaming `id` to `vesselId` in `selfReportedInfo` (#146).

details: add key to last report for consistency.
@AndreaSanchezTapia
Copy link
Member Author

AndreaSanchezTapia commented Jul 1, 2024

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

@jflowernet
Copy link

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"?

@AndreaSanchezTapia
Copy link
Member Author

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

@AndreaSanchezTapia
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API-side documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants