Skip to content

panukatan/openbangsamoro

openbangsamoro: An Interface to the OpenBangsamoro Database

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. Lifecycle: experimental R-CMD-check test-coverage Codecov test coverage CodeFactor

From the Open Bangsamoro website

The OpenBangsamoro initiative supports the use of open statistical, geospatial, and administrative data for transparent, accountable, and participatory decision-making as the Autonomous Region in Muslim Mindanao (ARMM) transforms into the Bangsamoro Autonomous Region in Muslim Mindanao.

The openbangsamoro R package supports this effort by providing an application programming interface to the Open Bangsamoro shared Google Drive. Consistent with the principles of Open Bangsamoro, the openbangsamoro R package is built and distributed open source on a platform that allows and encourages community contribution using a programming language that is also open and freely available to use.

We believe that through this added layer of interface to the Open Bangsamoro datasets, a cadre of users and developers - including those from Bangsamoro itself - can support the process of mapmaking, placemaking, and decision-making that the Open Bangsamoro effort has initiated and continue to encourage.

What does openbangsamoro do?

Please note that openbangsamoro is still highly experimental and is undergoing a lot of development. Hence, any functionalities described below and in the rest of the package documentation have a high likelihood of changing interface or approach as we aim for a stable working version.

Currently, the package provides functions for retrieving Google Drive specific drive information for the Open Bangsamoro Google Drive and its sub-directories.

Installation

openbangsamoro is not yet on CRAN but can be installed from the panukatan R universe as follows:

install.packages(
  "openbangsamoro",
  repos = c('https://panukatan.r-universe.dev', 'https://cloud.r-project.org')
)

Usage

Citation

If you find the openbangsamoro package useful please cite using the suggested citation provided by a call to the citation() function as follows:

citation("openbangsamoro")
#> To cite openbangsamoro in publications use:
#> 
#>   Ernest Guevarra (2024). openbangsamoro: An Interface to the Open
#>   Bangsamoro Database R package version 0.0.0.9000 URL
#>   https://panukatan.io/openbangsamoro/
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Manual{,
#>     title = {openbangsamoro: An Interface to the Open Bangsamoro Database},
#>     author = {{Ernest Guevarra}},
#>     year = {2024},
#>     note = {R package version 0.0.0.9000},
#>     url = {https://panukatan.io/openbangsamoro/},
#>   }

Community guidelines

Feedback, bug reports and feature requests are welcome; file issues or seek support here. If you would like to contribute to the package, please see our contributing guidelines.

This project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

About

An Interface to the OpenBangsamoro Database

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages