-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
75 lines (50 loc) · 4.06 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
67
68
69
70
71
72
73
74
---
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%"
)
```
# africalaws: Interface to the Laws.Africa API <img src="man/figures/logo.png" width="200" align="right" />
<!-- badges: start -->
[](https://www.repostatus.org/#wip)
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://github.com/OxfordIHTM/africalaws/actions/workflows/R-CMD-check.yaml)
[](https://github.com/OxfordIHTM/africalaws/actions/workflows/test-coverage.yaml)
[](https://codecov.io/gh/OxfordIHTM/africalaws)
[](https://www.codefactor.io/repository/github/oxfordihtm/africalaws)
<!-- badges: end -->
[Laws.Africa](https://laws.africa) endeavours to facilitate African governments in offering sustainable, free access to dependable digital laws. It aims to achieve this by ensuring that the laws are easily accessible, user-friendly, educational, and reusable. This initiative seeks to empower citizens with knowledge of their legal rights and obligations while promoting transparency and accountability within the legal system. Laws.Africa offers a content application programming interface (API) to fetch legislative content and metadata. The API is a read-only API for listing and fetching published versions of legislative works. This package interfaces with this API to allow access using R.
## What does `africalaws` do?
Please note that `africalaws` 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:
* Authenticating with the Laws.Africa API;
* Performing a call to the `countries` API endpoint; and,
* Performing a call to the `works` API endpoint.
From here, the plan is to continue developing functions that wrap the various available [API endpoints](https://developers.laws.africa/api/about-the-api).
## Installation
`africalaws` is not yet on CRAN but can be installed from the [Oxford iHealth R Universe](https://oxfordihtm.r-universe.dev) as follows:
```{r install-r-universe, eval = FALSE}
install.packages(
"africalaws",
repos = c('https://oxfordihtm.r-universe.dev', 'https://cloud.r-project.org')
)
```
## Usage
The following vignettes describe how to use the `africalaws` package.
* Authenticating with the Laws.Africa API
* Listing out countries and areas/locations with available works from the Laws.Africa API
* Listing out works for a specific country or areas/locations that are available from the Laws.Africa API
## Citation
If you find the `africalaws` package useful please cite using the suggested citation provided by a call to the `citation()` function as follows:
```{r citation}
citation("africalaws")
```
## Community guidelines
Feedback, bug reports and feature requests are welcome; file issues or seek support [here](https://github.com/OxfordIHTM/africalaws/issues). If you would like to contribute to the package, please see our [contributing guidelines](https://oxford-ihtm.io/africalaws/CONTRIBUTING.html).
This project is released with a [Contributor Code of Conduct](https://oxford-ihtm.io/africalaws/CODE_OF_CONDUCT.html). By participating in this project you agree to abide by its terms.