Package: biofetchR 0.1.0

biofetchR: Download, Clean, Classify, Enrich and Export Biodiversity Occurrence Data

Downloads, imports, cleans, classifies, enriches and exports biodiversity occurrence data, with an emphasis on reproducible Global Biodiversity Information Facility (GBIF) <https://api.gbif.org/v1/> workflows. The package supports batch occurrence downloads, taxonomic standardisation, coordinate cleaning, optional spatial thinning, spatial attribution and structured export of processed occurrence records and audit outputs. Terrestrial and freshwater workflows can join records to administrative units, protected areas, freshwater ecoregions, basins, rivers, lakes, reservoirs, wetlands and other contextual spatial overlays. Marine workflows support offshore and coastal records through joins to Marine Regions <https://www.marineregions.org/> style layers, Exclusive Economic Zone (EEZ) units, marine ecoregions, Large Marine Ecosystems and user-supplied marine overlays. The package also supports native-range and invasive-status evidence workflows using the World Register of Marine Species (WoRMS) <https://www.marinespecies.org/>, evidence derived from Standardising and Integrating Alien Species (SInAS) <https://zenodo.org/records/18220953>, and Global Register of Introduced and Invasive Species (GRIIS) <https://griis.org/> style species-country records. These tools are intended for biodiversity, macroecological and invasion-biology analyses where occurrence records need to be processed consistently, transparently and reproducibly.

Authors:Darren Stuart [aut, cre]

biofetchR_0.1.0.tar.gz
biofetchR_0.1.0.zip(r-4.7-any)biofetchR_0.1.0.zip(r-4.6-any)biofetchR_0.1.0.zip(r-4.5-any)
biofetchR_0.1.0.tgz(r-4.6-any)biofetchR_0.1.0.tgz(r-4.5-any)
biofetchR_0.1.0.tar.gz(r-4.7-any)biofetchR_0.1.0.tar.gz(r-4.6-any)
biofetchR_0.1.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html
DESCRIPTION
card.svg |card.png
biofetchR/json (API)

# Install 'biofetchR' in R:
install.packages('biofetchR', repos = c('https://dstuart505.r-universe.dev', 'https://cloud.r-project.org'))

On CRAN:

Conda:

This package does not link to any Github/Gitlab/R-forge repository. No issue tracker or development information is available.

3.40 score 85 exports 105 dependencies

Last updated from:64ff807e61. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK192
source / vignettesOK280
linux-release-x86_64OK221
macos-release-arm64OK267
macos-oldrel-arm64OK221
windows-develOK197
windows-releaseOK190
windows-oldrelOK199
wasm-releaseOK158

Exports:append_summary_rowbf_apply_manual_taxonomy_fixesbf_attach_gbif_taxonomybf_attach_griis_statusbf_attach_native_statusbf_available_marine_overlaysbf_available_native_web_sourcesbf_bind_gbif_chunksbf_cache_dirbf_check_taxonomic_resolutionbf_clean_taxon_namesbf_download_griisbf_download_sinas_resourcesbf_enrich_raster_contextbf_enrich_raster_context_from_sourcesbf_fetch_native_ranges_sinasbf_fetch_native_ranges_webbf_filter_griis_invasivebf_filter_nativebf_filter_non_nativebf_find_griis_tablebf_griis_lookupbf_load_basinsbf_load_biosphere_reservebf_load_feowbf_load_gdw_barriersbf_load_gdw_reservoirsbf_load_global_miningbf_load_gloricbf_load_hydrowastebf_load_lakesbf_load_marine_regions_overlaybf_load_ne_admin1bf_load_ne_urbanbf_load_ne_urban_areasbf_load_ramsarbf_load_resolve_ecoregions2017bf_load_resolve2017bf_load_riversbf_load_teowbf_load_wdpabf_marine_overlay_canonicalbf_name_rivers_osmbf_native_range_lookupbf_native_status_summarybf_prepare_taxa_for_gbifbf_read_griisbf_reconcile_griis_native_statusbf_resolve_gbif_taxonomybf_resolve_gbif_taxonomy_batchbf_sinas_default_urlsbf_standardise_griisbf_standardise_native_rangesbf_tax_extract_genusbf_tax_is_genus_levelbf_tax_looks_non_taxonbf_taxonomic_summarybf_teow_cache_infobf_teow_clear_cachebf_unpack_griisbf_web_native_gbifbf_web_native_wormsbf_write_native_web_outputscheck_entrez_keycheck_gbif_presencedownload_gbif_batchdownload_gbif_batch_gadmeez_joinfilter_by_statusgadm_joinget_taxon_keyinitialize_summaryinstall_optional_depsis_marine_specieslist_status_presetsload_all_gadmload_gadmoverlay_joinprocess_gbif_eez_pipelineprocess_gbif_marine_pipelineprocess_gbif_terrestrial_freshwater_pipelineresolve_species_namesthin_spatial_pointswait_and_import_gbifwait_and_import_gbif_safe

Dependencies:askpassbackportsbitbit64brewcachemcallrcheckmateclassclassIntclicliprcommonmarkCoordinateCleanercountrycodecpp11crayoncrulcurldata.tableDBIdescdigestdplyre1071evaluatefarverfastmapfsgenericsgeodatageosphereggplot2gluegtablehighrhmshttpcodehttrhttr2isobandISOcodesjsonliteKernSmoothknitrlabelinglazyevallifecyclemagrittrMASSmemoisemimemregions2oaiopensslotelpillarpkgbuildpkgconfigpkgloadplyrprettyunitsprocessxprogressproxypspurrrR6rappdirsRColorBrewerRcpprdflibreadrredlandrgbifrlangrnaturalearthroxygen2rprojroots2S7scalessfstringistringrsysterratibbletidyrtidyselecttriebeardtzdbunitsurltoolsutf8vctrsviridisLitevroomwhiskerwithrwkwraprxfunxml2yaml

Auditing and scaling biofetchR workflows
Purpose | Recommended output structure | The main summary file | Example summary table | Status checks | Record-retention checks | Rows needing review | Output-file checks | Rerunning problem rows | Preserving evidence and spatial audit outputs | Scaling, memory and runtime | Provider metadata and session information | Final checklist

Last update: 2026-07-21
Started: 2026-07-21

Batch occurrence pipelines in biofetchR
Purpose | Using the examples | Batch input tables | Credential and output setup | Coordinate cleaning and spatial thinning | A low-memory terrestrial smoke test | Example summary output | Scaling to a terrestrial or freshwater batch | Adding terrestrial and freshwater overlays | Marine batch pipeline | Output files and audit trail | Practical recommendations

Last update: 2026-07-21
Started: 2026-07-21

Marine occurrence workflows in biofetchR
Purpose | Using the examples | Marine workflow sequence | Marine input tables | Choosing a marine overlay | Extended marine overlays | Running complementary marine overlays | Loading a marine overlay directly | A low-memory marine smoke test | Offline summary example | Running and comparing multiple marine overlays | Coordinate cleaning and spatial thinning | Origin and invasive-status evidence in marine workflows | Inspecting exported marine occurrence files | Scaling marine workflows | Recommended output organisation | Common problems | Provider caches and citations | Suggested provider citations | Practical recommendations

Last update: 2026-07-21
Started: 2026-07-21

Native-range and invasive-status evidence in biofetchR
Purpose | Using the examples | Evidence workflow overview | Taxonomic preparation before status assignment | Example species-country input | Status categories | Project native-range evidence | Attaching native-range evidence | Filtering modes | Native-range evidence from web/API sources | GRIIS invasive-status evidence | Origin-status audit table | Recommended default settings | Origin evidence inside the batch pipeline | Interpreting pipeline audit outputs | Final checklist | Provider citations

Last update: 2026-07-21
Started: 2026-07-21

Spatial overlays and raster context in biofetchR
Purpose | Using the examples | Vector overlays and raster context | Choosing a spatial framework | Example occurrence table | Cleaning and thinning before spatial overlays | Cleaning only | Keeping high-uncertainty records but flagging them | Distance-based thinning | Cleaning and thinning inside the pipelines | Primary and secondary spatial context | Common overlay types | GADM administrative attribution | GADM inside the terrestrial and freshwater pipeline | Combining administrative and ecological context | Direct provider loaders | Using overlays with an existing occurrence table | Raster context | Protected-area and wetland overlays | Inspecting spatial outputs | Troubleshooting spatial joins | Provider caches and citations | Final checklist

Last update: 2026-07-21
Started: 2026-07-21

Readme and manuals

Help Manual

Help pageTopics
Append a row to a GBIF processing summary tableappend_summary_row
Apply manual taxonomy name and rank fixes to a data framebf_apply_manual_taxonomy_fixes
Attach GBIF taxonomy to a data framebf_attach_gbif_taxonomy
Attach GRIIS status to a species or species-country tablebf_attach_griis_status
Attach native/non-native recipient status to a data framebf_attach_native_status
List package-supported marine overlaysbf_available_marine_overlays
List web sources supported for native-range evidencebf_available_native_web_sources
Harmonise and bind GBIF result chunksbf_bind_gbif_chunks
Get a writable cache directory for biofetchR spatial layersbf_cache_dir
Check taxonomic resolution qualitybf_check_taxonomic_resolution
Clean taxon names before taxonomy resolutionbf_clean_taxon_names
Download the GRIIS country compendiumbf_download_griis
Download and locate required SInAS resourcesbf_download_sinas_resources
Enrich GBIF points with raster context layersbf_enrich_raster_context
Enrich point occurrences from explicitly supplied raster context layersbf_enrich_raster_context_from_sources
Fetch native-origin evidence from SInASbf_fetch_native_ranges_sinas
Compile species-level native-origin evidence from web sourcesbf_fetch_native_ranges_web
Keep rows flagged as invasive in GRIISbf_filter_griis_invasive
Filter a data frame to confirmed native recipient recordsbf_filter_native
Filter a data frame to confirmed non-native recipient recordsbf_filter_non_native
Find the most likely GRIIS table in an unpacked archivebf_find_griis_table
Build a compact GRIIS lookup tablebf_griis_lookup
Load nested basins (HydroBASINS; Pfafstetter)bf_load_basins
Load UNESCO biosphere reserve locationsbf_load_biosphere_reserve
Load Freshwater Ecoregions of the World polygonsbf_load_feow
Load Global Dam Watch river barrier pointsbf_load_gdw_barriers
Load Global Dam Watch reservoir polygonsbf_load_gdw_reservoirs
Load global mining polygonsbf_load_global_mining
Load GloRiC river reach linesbf_load_gloric
Load HydroWASTE wastewater treatment plant pointsbf_load_hydrowaste
Load global lake polygons (HydroLAKES)bf_load_lakes
Load a package-managed Marine Regions overlaybf_load_marine_regions_overlay
Load Natural Earth Admin-1 (States/Provinces) (auto-download + cache)bf_load_ne_admin1
Load Natural Earth Urban Areas (auto-download + cache)bf_load_ne_urban
Load Natural Earth Urban Areas (polygons), auto-downloaded and cachedbf_load_ne_urban_areas
Load Ramsar wetland polygons for selected countriesbf_load_ramsar
Load RESOLVE Ecoregions 2017 (polygons), auto-downloaded and cachedbf_load_resolve_ecoregions2017
Load RESOLVE Ecoregions (2017) (auto-download + cache)bf_load_resolve2017
Load global river reaches (HydroRIVERS) with optional cachingbf_load_rivers
Load & cache WWF Terrestrial Ecoregions (TEOW)bf_load_teow
Load WDPA protected-area polygons for selected countriesbf_load_wdpa
Resolve a marine overlay alias to its canonical namebf_marine_overlay_canonical
Annotate HydroRIVERS reaches with OSM river namesbf_name_rivers_osm
Build a native-range lookup tablebf_native_range_lookup
Summarise native-origin status columnsbf_native_status_summary
Prepare taxon names for GBIF download pipelinesbf_prepare_taxa_for_gbif
Read and standardise the GRIIS country compendiumbf_read_griis
Reconcile GRIIS and native-origin evidencebf_reconcile_griis_native_status
Resolve one taxon name against GBIFbf_resolve_gbif_taxonomy
Resolve a vector of taxon names against GBIFbf_resolve_gbif_taxonomy_batch
Return default SInAS 3.1.1 resource URLsbf_sinas_default_urls
Standardise a raw GRIIS tablebf_standardise_griis
Standardise native-range evidence to a species-level lookupbf_standardise_native_ranges
Extract the genus component from a taxon namebf_tax_extract_genus
Detect genus-level or open-nomenclature namesbf_tax_is_genus_level
Detect likely non-taxonomic stringsbf_tax_looks_non_taxon
Summarise taxonomy resolution outcomesbf_taxonomic_summary
Return cache path/info for TEOWbf_teow_cache_info
Clear the cached TEOW datasetbf_teow_clear_cache
Unpack a cached GRIIS archivebf_unpack_griis
Fetch native-range evidence from the GBIF Species APIbf_web_native_gbif
Fetch native-range evidence from WoRMS REST distributionsbf_web_native_worms
Write native-range web evidence outputsbf_write_native_web_outputs
Check for NCBI Entrez API Keycheck_entrez_key
Check whether GBIF has coordinate-based records for a speciescheck_gbif_presence
Submit global GBIF download jobs for species-level workflowsdownload_gbif_batch
Submit country-filtered GBIF downloads for terrestrial/freshwater workflowsdownload_gbif_batch_gadm
Join GBIF points to Exclusive Economic Zone polygonseez_join
Filter or normalise records by native/alien statusfilter_by_status
Attach GADM labels to occurrence pointsgadm_join
Retrieve a GBIF taxonKey for a scientific nameget_taxon_key
Initialise a GBIF processing summary tableinitialize_summary
Report optional biofetchR dependenciesinstall_optional_deps
Determine if a species is likely marine from taxonomyis_marine_species
List available native/non-native status presetslist_status_presets
Load and bind GADM geometries for multiple countriesload_all_gadm
Load GADM administrative geometriesload_gadm
Join GBIF points to Marine Regions overlays (robust, with s2 fallback)overlay_join
Run the marine pipeline through the legacy EEZ wrapperprocess_gbif_eez_pipeline
Process marine GBIF occurrences using package-managed marine overlaysprocess_gbif_marine_pipeline
Process terrestrial and freshwater GBIF occurrencesprocess_gbif_terrestrial_freshwater_pipeline
Resolve and standardise species namesresolve_species_names
Clean and spatially thin GBIF-style occurrence pointsthin_spatial_points
Wait for GBIF occurrence downloads and import completed recordswait_and_import_gbif
Import GBIF downloads through the package import helperwait_and_import_gbif_safe