Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

Recent Releases of gfwr

gfwr - gfwr 3.0

This is a major release of the package, with several changes and additions.

Breaking changes

  • Prefix change: All gfwr functions are now prefixed with gfw_ to make a
    direct reference to the package. This replaces the prefix get_.
    This allows functions from the package to appear together in searches and menus, and avoids possible confusion with other functions starting with "get_" in other R packages

  • In addition to the prefix change, get_raster() was renamed to
    gfw_ais_fishing_hours() to avoid confusion with the new incoming "raster"
    datasets implemented in this version and to be consistent with the output of the
    model, which is expressed in (apparent) fishing hours.

  • The two datasets in the package were also renamed to gfw_: gfw_marine_regions and gfw_test_shape

  • In gfw_region_id(), the parameter region_name was renamed to region for precision, since it accepts both region names and ISO codes. (#196)

New functions and endpoints

  • gfw_ais_presence() implements the AIS-based Vessel presence dynamic
    dataset, which can be found in the Global Fishing Watch map.
    This dataset aggregates the presence of all vessels (fishing and non-fishing), expressed in hours of activity in each cell.
  • gfw_sar_vessel_detections() incorporates the SAR-based vessel detections
    (presence), also found in the map. See Paolo et al 2024 for more details.

Non-breaking changes

  • gfw_event() has no longer the gap_intentional_disabling parameter because all gaps returned are high confidence and considered to be intentional:
    • The gap event must be at least 12 hours
    • It must start at least 50 nautical miles from shore
    • It must start in an area with a satellite reception quality greater than 10 positions per day
    • The vessel must have at least 14 satellite positions in the 12 hours prior to the gap
      See the gap events documentation for more details behind these rules.

Bug fixes

  • fixed gfw_event_stats() (previously get_event_stats()) filter by flag (#215)
  • fixed #224 and gfw_marine_regions dataset (previously marine_regions) is available without attaching gfwr (thanks to @jaseeverett)
  • fixes the includes parameter of gfw_vessel_info(), reported in #231

Biosphere - Marine Life and Fishery - HTML
Published by AndreaSanchezTapia 4 months ago

gfwr - gfwr 2.0.4

Aug 5 2025

No breaking changes

  • Adds a new dataset, marine_regions, a simplified version of the Marine Regions v12 table to retrieve IDs when region_source = "EEZ".

Full Changelog: https://github.com/GlobalFishingWatch/gfwr/compare/v.2.0.3...v.2.0.4

Biosphere - Marine Life and Fishery - HTML
Published by AndreaSanchezTapia 10 months ago

gfwr - gfwr 2.0.3

No breaking changes

Bug fixes

  • geartypes and shiptypes will be unnested only when they are returned in the
    responses--this was causing an error reported in #193
  • get_region_id():
    • MPA, EEZ, RFMO ids are no longer enforced to be numeric,
      this was causing errors for character and alphanumeric ids in RFMOS and MPAs
    • get_region_id() can now process empty id strings ("") and return NA
      tibbles instead of returning an error, this allows to process events happening
      in the high-seas (#201)

Documentation improvements

  • get_event() can receive a string of several vesselIds (not twenty as
    previously stated). However, requests that are too long in character length will
    fail with error HTTP 422: Unprocessable entity. This means around 2,000
    vesselIDs can be sent per request.
  • RFMO documentation was improved to clarify that we have the complete list of
    RFMOs #194
  • The readme has more subsections for easier reference and explicit calls to
    gfw_auth() are no longer suggested.
    Full Changelog: https://github.com/GlobalFishingWatch/gfwr/compare/v.2.0.2...v.2.0.3

Biosphere - Marine Life and Fishery - HTML
Published by AndreaSanchezTapia about 1 year ago

gfwr - gfwr 2.0.2

General review of the documentation, parameter reordering and improving descriptions. No breaking changes.

What's Changed

Full Changelog: https://github.com/GlobalFishingWatch/gfwr/compare/v.2.0.1...v.2.0.2

Biosphere - Marine Life and Fishery - HTML
Published by AndreaSanchezTapia about 1 year ago

gfwr - gfwr 2.0.1

Major change - bug fix

  • We updated the parsing of the output of get_vessel_info(). For some advanced
    queries using where, the function was returning only a subset of the vessels.
    This issue is now solved and the number of results should be equal to the number
    of vessels returned by Vessel Viewer on our map. (solves #176)

Breaking changes

  • Some fields in the response were renamed across outputs (addressing issue #146):

    • get_vessel_info(): in $registryInfo we renamed id to registryId
    • get_event(): we renamed id to eventId and type to eventType

New features

  • get_vessel_info(): We added an index column to indicate which vesselIds
    are grouped together and belong to the same vessel. This should help associate
    information from the returned datasets and guide the user when requesting events
    for a single vessel or a group of vessels.

  • get_event(): We unnested the column-list "vessel" to give more visibility to
    the vessels each event corresponds to.

Minor changes

  • We updated the get_event() section in the README to improve the workflow and
    send groups of vesselIds corresponding to one or multiple vessels.

Biosphere - Marine Life and Fishery - HTML
Published by rociojoo over 1 year ago

gfwr - gfwr 2.0.0

gfwr was updated to work with version 3 of our APIs. This results in various breaking changes in parameter names and output formats. We aim to list here the major modifications but please also check the API documentation and the migration guide if anything is new or missing.

Endpoints

  • Same endpoints as in v1.1.0

    • get_raster() communicates with the 4Wings API to get fishing effort
    • get_vessel_info() communicates with the Vessels API
    • get_event() communicates with the Events API

  • New endpoints:

    • get_events_stats() to get events statistics worldwide or for a specific
      region
    • get_last_report() to check status of last API request to get_raster()

Note: Some APIs will not be implemented because they were primarily designed for a front-end application rather than for data download. These APIs are:

  • /v3/4wings/generate-png
  • /v3/4wings/tile/:type/:z/:x/:y
  • /v3/4wings/interaction/{z}/{x}/{y}/{cells}
  • /v3/4wings/bins/:z

Major changes and new features

  • General

    • Improved documentation in-package, including two vignettes that can be accessed
      on our website https://globalfishingwatch.github.io/gfwr/
    • Functions have a new parameter print_request that will print the API request and
      will be useful when requesting support. Please describe the problem, send a simplified
      script and copy the string of the request when filling an issue.
    • The region argument for get_raster() and get_event() now accepts sf polygons rather than GeoJSON strings

  • get_vessel_info()

    • Incorporated non-fishing vessel types to the datasets. A simple search will return
      vessels of all vessel types ("CARRIER", "SUPPORT", "PASSENGER", "OTHER_NON_FISHING", "SEISMIC_VESSEL", "BUNKER_OR_TANKER", and "CARGO" in addition to "FISHING")
    • search_type = search replaces search type = "basic" and "advanced". Instead, use parameter query for basic search or parameter where for advanced search (i.e. when using SQL expressions)
    • Registry information is now available: Parameter includes allows the search to include ownership information, public authorizations from public registries, and the criteria for matching with AIS data

  • get_event()

    • Vessel types supported now include non-fishing vessels: "FISHING", "CARRIER", "SUPPORT", "PASSENGER", "OTHER_NON_FISHING", "SEISMIC_VESSEL", "BUNKER_OR_TANKER", and "CARGO"
    • Event types now include fishing, gaps in AIS transmission, encounters, loitering events and port visits. Fishing events are specific to fishing vessels, loitering events are specific to carrier vessels. Port visits and encounters are available for all vessel types. Parameter confidence (1 to 4) allows filtering for high-confidence port visits.
    • All parameters must now be specified using UPPER CASE (ex. event_type = "FISHING" instead of event_type = "fishing")
    • A user-defined shapefile can now be sent in the requests, as an sf object

  • get_raster()

    • All parameters must now be specified using UPPER CASE (ex. spatial_resolution = "LOW" instead of spatial_resolution = "low")
    • The region argument now accepts sf polygons rather than a GeoJSON string
    • Parameters start_date and end_date replace date_range for consistency with other functions

Biosphere - Marine Life and Fishery - HTML
Published by AndreaSanchezTapia over 1 year ago

gfwr - v1.1.0

New features:

  • In addition to your own JSON region, can now pass EEZ or MPA id to get_raster function to query specific region

  • get_region_id now takes id and returns label. This allows you to get the label for the id values returned by certain endpoints (e.g. get_event)

  • Considerable speed increases in get_event function

Bug fixes:

  • get_event prints "Your request returned zero results" and returns NULL when the API response contains no results instead of causing an error.

Other news:

Updated documentation

  • get_raster: requires group_by and appropriate parameter name is gearType

  • Added a NEWS.md file to track changes to the package.

Biosphere - Marine Life and Fishery - HTML
Published by tclavelle over 3 years ago

gfwr - Initial gfwr release

This is the initial release of the gfwr package. It includes functions to access three GFW APIs - Vessels API, Events API, and Map Visualization (4Wings) API. Updated release to add DOI.

Biosphere - Marine Life and Fishery - HTML
Published by tclavelle almost 4 years ago