-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
66 lines (45 loc) · 4.11 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# openbangsamoro: An Interface to the OpenBangsamoro Database <img src="man/figures/logo.png" width="200px" align="right" />
<!-- badges: start -->
[](https://www.repostatus.org/#wip)
[](https://www.tidyverse.org/lifecycle/#experimental)
[](https://github.com/panukatan/openbangsamoro/actions/workflows/R-CMD-check.yaml)
[](https://github.com/panukatan/openbangsamoro/actions/workflows/test-coverage.yaml)
[](https://codecov.io/gh/panukatan/openbangsamoro?branch=main)
[](https://www.codefactor.io/repository/github/panukatan/openbangsamoro)
<!-- badges: end -->
From the [Open Bangsamoro website](https://www.openbangsamoro.com/)
> The [**OpenBangsamoro** initiative](https://www.openbangsamoro.com) 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](https://drive.google.com/drive/folders/1W8JV4hth_gs1V6efb92HMz0eU2LRYbOO). 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](https://panukatan.r-universe.dev) as follows:
```{r install-r-universe, eval = FALSE}
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:
```{r citation}
citation("openbangsamoro")
```
## Community guidelines
Feedback, bug reports and feature requests are welcome; file issues or seek support [here](https://github.com/panukatan/openbangsamoro/issues). If you would like to contribute to the package, please see our [contributing guidelines](https://panukatan.io/openbangsamoro/CONTRIBUTING.html).
This project is released with a [Contributor Code of Conduct](https://panukatan.io/openbangsamoro/CODE_OF_CONDUCT.html). By participating in this project you agree to abide by its terms.