inAccessMod

inAccessMod: An R package to automate data downloading and processing for AccessMod - Published in JOSS (2024)

https://github.com/unige-geohealth/inaccessmod

Science Score: 98.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 6 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • Institutional organization owner
    Organization unige-geohealth has institutional domain (www.unige.ch)
  • JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: unige-geohealth
  • License: gpl-3.0
  • Language: R
  • Default Branch: main
  • Size: 20.2 MB
Statistics
  • Stars: 10
  • Watchers: 2
  • Forks: 6
  • Open Issues: 0
  • Releases: 3
Created almost 4 years ago · Last pushed 6 months ago
Metadata Files
Readme License

README.md

DOI

inAccessMod

AccessMod is a World Health Organization-recognized, free and open source software tool that allows users to model the geographic accessibility of health services. To model the geographic accessibility of health services, several layers of input data reflecting barriers and facilitators to the mobility of the target population are required in conjunction with data on the location and availability of health services. More information on AccessMod installation and use can be found here: https://www.accessmod.org/

inAccessMod is a R package that allows the user to easily download and prepare all the required layers for AccessMod. A proper folder structure is created in order to manage multi-temporal data and/or multiple analysis scenarios. While the functions to process health facility tables are specifically designed to handle data from The Health Resources and Services Availability Monitoring System (HeRAMS), the other ones can be used for any other project. The layer downloading, cropping, masking, resampling, exporting processes are automated to a large degree, making the preparation of the inputs quick and straightforward.

How to cite: Timoner, P., Hierink, F., Baecher, L., Fuhrer, C. and Ray, N. (2024). inAccessMod: An R package to automate data downloading and processing for AccessMod. Journal of Open Source Software, 9(93), 5879, https://doi.org/10.21105/joss.05879

Installation

This package requires R version 4.1.3 or later. It also requires the following packages: crsuggest, data.table, dplyr, exactextractr, fasterize, fs, geodata, jsonlite, lubridate, osmextract, purrr, raster, RCurl, readxl, rgeoboundaries (version 0.0.0.9000 or later), rmarkdown, sf, stringi, stringr, testthat, tibble, utils, and writexl. These dependencies should be installed automatically when dependencies = TRUE is set in the command used to install the package.

if (!require("devtools")) install.packages("devtools") devtools::install_github("unige-geohealth/inAccessMod", build_vignettes = TRUE, dependencies = TRUE)

If you decide to install the dependencies manually, please note that rgeoboundaries must be installed using remotes or devtools:

devtools::install_github("wmgeolab/rgeoboundaries")

Main functions

  • initiate_project: Allows starting a new project by choosing the country (or city) and retrieving the official ISO alpha-3 code.
  • download_boundaries: Downloads the required administrative boundaries from the geoBoundaries database.
  • set_projection: Sets the projected coordinate reference system (CRS) for the project to ensure that all input layers have a consistent projection.
  • HeRAMS_filter_hf: Filters the health facility data based on user criteria (only compatible with WHO/HeRAMS data).
  • HeRAMS_create_hf_shapefile: Creates a shapefile of health facilities (only compatible with WHO/HeRAMS data).
  • download_dem: Downloads the Digital Elevation Model (DEM) raster for the country/area of interest from the Shuttle Radar Topography Mission (SRTM) dataset.
  • download_population: Downloads the population count raster for the target country/area from the WorldPop project.
  • download_landcover: Downloads the land cover raster for the country/area of interest from the Copernicus Land Monitoring Service.
  • download_osm: Downloads road, river, lake, and other natural barriers shapefiles from the OpenStreetMap (OSM) platform
  • process_inputs: Processes all the raw input data by cropping, masking, projecting, and resampling the geospatial layers with customizable user parameters.
  • compile_processed_data: Compiles all the processed data into one single folder, making it easier to import the input data into AccessMod.
  • multi_ts: Handles different travel scenarios for different administrative units.
  • hf_best_cov: Selects the health facilities that provide the best population coverage based on their catchments and a population raster.

Tutorial

You can access the tutorial directly in R using the following command, or by opening the TUTORIAL file located in the main directory of the repository. Remember that you must have a working internet connection in order to access all the functions that allow you to download data.

vignette("Tutorial", package = "inAccessMod")

Automated tests

After cloning the repository, go to the package main directory and run:

devtools::test()

Contributor guidelines

Contributions are welcome and greatly appreciated! To contribute, please follow the following guidelines:

Reporting issues

Development process

  • Fork the repository, make changes in your fork, and submit a pull request.
  • Follow the existing coding style and structure.
  • Write tests for any new functionality.
  • Document any changes in the package documentation.

Where to get help

Owner

  • Name: Université de Genève - GeoHealth
  • Login: unige-geohealth
  • Kind: organization
  • Email: nicolas.ray@unige.ch
  • Location: Switzerland

JOSS Publication

inAccessMod: An R package to automate data downloading and processing for AccessMod
Published
January 07, 2024
Volume 9, Issue 93, Page 5879
Authors
Pablo Timoner ORCID
GeoHealth group, Institute of Global Health, Faculty of Medicine, University of Geneva, Geneva, Switzerland
Fleur Hierink ORCID
GeoHealth group, Institute of Global Health, Faculty of Medicine, University of Geneva, Geneva, Switzerland
Loïc Baecher
GeoHealth group, Institute of Global Health, Faculty of Medicine, University of Geneva, Geneva, Switzerland
Caroline Fuhrer
Health Resources and Services Availability Monitoring System (HeRAMS) Initiative, World Health Organization Headquarters. Geneva, Switzerland.
Nicolas Ray ORCID
GeoHealth group, Institute of Global Health, Faculty of Medicine, University of Geneva, Geneva, Switzerland
Editor
Arfon Smith ORCID
Tags
GIS geographical accessibility health coverage

GitHub Events

Total
  • Issues event: 3
  • Watch event: 1
  • Issue comment event: 3
  • Push event: 4
  • Fork event: 1
  • Create event: 2
Last Year
  • Issues event: 3
  • Watch event: 1
  • Issue comment event: 3
  • Push event: 4
  • Fork event: 1
  • Create event: 2

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 327
  • Total Committers: 2
  • Avg Commits per committer: 163.5
  • Development Distribution Score (DDS): 0.009
Past Year
  • Commits: 15
  • Committers: 1
  • Avg Commits per committer: 15.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Pablo Timoner P****r@u****h 324
Rik Lubbers 1****s 3
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 8
  • Total pull requests: 5
  • Average time to close issues: 16 days
  • Average time to close pull requests: 2 days
  • Total issue authors: 6
  • Total pull request authors: 4
  • Average comments per issue: 2.75
  • Average comments per pull request: 0.6
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 0
  • Average time to close issues: about 1 month
  • Average time to close pull requests: N/A
  • Issue authors: 3
  • Pull request authors: 0
  • Average comments per issue: 1.67
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • ConnorDonegan (2)
  • YG1975 (1)
  • nicolasray (1)
  • mponce0 (1)
  • DemevengDerrick (1)
Pull Request Authors
  • loicbaecher (2)
  • RikLubbers (2)
  • ptimoner (2)
  • mponce0 (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

DESCRIPTION cran
  • R >= 4.1.3 depends
  • RCurl * imports
  • crsuggest * imports
  • dplyr * imports
  • exactextractr * imports
  • fasterize * imports
  • fs * imports
  • gdalUtils >= 2.0.3.2 imports
  • lubridate * imports
  • osmextract * imports
  • purrr * imports
  • raster * imports
  • readxl * imports
  • rgdal * imports
  • rgeoboundaries >= 0.0.0.9000 imports
  • rgeos * imports
  • rmarkdown * imports
  • sf * imports
  • sp * imports
  • stringi * imports
  • stringr * imports
  • tibble * imports
  • utils * imports
  • writexl * imports
  • knitr * suggests
.github/workflows/draft-pdf.yml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite