expand vessel insights types, documentation, and test coverage#242
Open
expand vessel insights types, documentation, and test coverage#242
Conversation
This: - add `get_vessel_insights()` for interacting with the vessels insights API - add `with_gfw_json_fixture()` helper for loading fixture JSON files in tests
This also: - export `get_vessel_insights` and update NAMESPACE - improve validation, error messages, and date parsing - default API key to `gfw_auth()` - refactor request body construction for Insights API - update examples, fixtures, and tests to match new interface - reformat JSON fixtures for consistency and clarity
…tion tests This: - add `print_request` flag to optionally print the HTTP request for debugging - fix typo in missing API token error message - expand unit tests to cover NULL, NA, empty string, and envvar-based key errors - improve documentation and examples for the new debug option
…bble This: - improve documentation with detailed @description, @details, and @examples - normalize Insights API response into a single-row tibble with list-columns - update unit tests to assert tibble structure and exact response mapping
This: - addresses and closes #162 - rename `get_vessel_insights()` to `gfw_vessel_insights()` - update roxygen examples to use new function name - regenerate `NAMESPACE` to export `gfw_vessel_insights` instead of `get_vessel_insights` - update all testthat references and expectations to use `gfw_vessel_insights`
…st coverage This: - expand insight types to include `"VESSEL-IDENTITY-FLAG-CHANGES"` and `"VESSEL-IDENTITY-MOU-LIST"` - update `gfw_vessel_insights()` documentation to reflect additional insight types - add examples demonstrating retrieval of flag change insights and Tokyo/Paris MOU list insights - update JSON test fixtures to include flag change history and MOU list presence - extend unit tests structural assertions for period, gap, coverage, fishing, and vessel identity
lykmapipo
added
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This:
"VESSEL-IDENTITY-FLAG-CHANGES"and"VESSEL-IDENTITY-MOU-LIST"insight typesgfw_vessel_insights()documentation to reflect newly supported insightsperiod,gap,coverage,fishing, andvessel identityinsights