Skip to content

Commit

Permalink
change package name
Browse files Browse the repository at this point in the history
  • Loading branch information
ernestguevarra committed Feb 13, 2024
1 parent a71cb32 commit 34a5f62
Show file tree
Hide file tree
Showing 46 changed files with 2,473 additions and 147 deletions.
6 changes: 3 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Package: icd
Package: codigo
Type: Package
Title: Interface to the International Classification of Diseases (ICD) API
Version: 0.0.0.9000
Expand Down Expand Up @@ -30,5 +30,5 @@ LazyData: true
Language: en-GB
RoxygenNote: 7.2.3
Roxygen: list(markdown = TRUE)
URL: https://oxford-ihtm.io/icd/, https://github.com/OxfordIHTM/icd
BugReports: https://github.com/OxfordIHTM/icd/issues
URL: https://oxford-ihtm.io/codigo/, https://github.com/OxfordIHTM/codigo
BugReports: https://github.com/OxfordIHTM/codigo/issues
2 changes: 1 addition & 1 deletion R/icd.R → R/codigo.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
#'
#' @docType package
#' @keywords internal
#' @name icd
#' @name codigo
#' @importFrom httr oauth2.0_token oauth_app oauth_endpoint
#' @importFrom httr2 oauth_client request req_url_query req_headers
#' req_oauth_client_credentials req_perform
Expand Down
24 changes: 12 additions & 12 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ knitr::opts_chunk$set(
)
```

# icd: Interface to the International Classification of Diseases (ICD) API
# codigo: Interface to the International Classification of Diseases (ICD) API <img src="man/figures/logo.png" width="200" align="right" />

<!-- badges: start -->
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
Expand All @@ -26,28 +26,28 @@ knitr::opts_chunk$set(

The [International Classification of Diseases (ICD)](https://www.who.int/standards/classifications/classification-of-diseases) serves a broad range of uses globally and provides critical knowledge on the extent, causes and consequences of human disease and death worldwide via data that is reported and coded with the ICD. [ICD API](https://icd.who.int/icdapi) allows programmatic access to the ICD. It is an HTTP based REST API. This package provides functions that interface with the ICD API.

## What does `icd` do?
## What does `codigo` do?

Please note that `icd` is still highly experimental and is undergoing a lot of development. Hence, any functionalities described below have a high likelihood of changing interface or approach as we aim for a stable working version.
Please note that `codigo` is still highly experimental and is undergoing a lot of development. Hence, any functionalities described below 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 ICD API. From here, the plan is to develop functions that wrap the various available [API endpoints](https://id.who.int/swagger/index.html).

## Installation

`icd` is not yet on CRAN.
`codigo` is not yet on CRAN.

You can install the development version of `icd` from [GitHub](https://github.com/OxfordIHTM/icd) with:
You can install the development version of `codigo` from [GitHub](https://github.com/OxfordIHTM/codigo) with:

```{r gh-installation1, eval = FALSE}
if(!require(remotes)) install.packages("remotes")
remotes::install_github("OxfordIHTM/icd")
remotes::install_github("OxfordIHTM/codigo")
```

then load `icd`
then load `codigo`

```{r gh-installation2, eval = TRUE}
# load package
library(icd)
library(codigo)
```

## Usage
Expand Down Expand Up @@ -98,14 +98,14 @@ The output is a list parsed from the JSON body text of the HTTP response from th
## Citation
If you find the `icd` package useful please cite using the suggested citation provided by a call to the `citation()` function as follows:
If you find the `codigo` package useful please cite using the suggested citation provided by a call to the `citation()` function as follows:
```{r citation}
citation("icd")
citation("codigo")
```
## Community guidelines
Feedback, bug reports and feature requests are welcome; file issues or seek support [here](https://github.com/OxfordIHTM/icd/issues). If you would like to contribute to the package, please see our [contributing guidelines](https://oxford-ihtm.io/icd/CONTRIBUTING.html).
Feedback, bug reports and feature requests are welcome; file issues or seek support [here](https://github.com/OxfordIHTM/codigo/issues). If you would like to contribute to the package, please see our [contributing guidelines](https://oxford-ihtm.io/codigo/CONTRIBUTING.html).
This project is released with a [Contributor Code of Conduct](https://OxfordIHTM/codeditr/CODE_OF_CONDUCT.html). By participating in this project you agree to abide by its terms.
This project is released with a [Contributor Code of Conduct](https://OxfordIHTM/codigo/CODE_OF_CONDUCT.html). By participating in this project you agree to abide by its terms.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# icd: Interface to the International Classification of Diseases (ICD) API
# codigo: Interface to the International Classification of Diseases (ICD) API <img src="man/figures/logo.png" width="200" align="right" />

<!-- badges: start -->

Expand All @@ -26,10 +26,10 @@ API](https://icd.who.int/icdapi) allows programmatic access to the ICD.
It is an HTTP based REST API. This package provides functions that
interface with the ICD API.

## What does `icd` do?
## What does `codigo` do?

Please note that `icd` is still highly experimental and is undergoing a
lot of development. Hence, any functionalities described below have a
Please note that `codigo` is still highly experimental and is undergoing
a lot of development. Hence, any functionalities described below have a
high likelihood of changing interface or approach as we aim for a stable
working version.

Expand All @@ -40,21 +40,21 @@ endpoints](https://id.who.int/swagger/index.html).

## Installation

`icd` is not yet on CRAN.
`codigo` is not yet on CRAN.

You can install the development version of `icd` from
[GitHub](https://github.com/OxfordIHTM/icd) with:
You can install the development version of `codigo` from
[GitHub](https://github.com/OxfordIHTM/codigo) with:

``` r
if(!require(remotes)) install.packages("remotes")
remotes::install_github("OxfordIHTM/icd")
remotes::install_github("OxfordIHTM/codigo")
```

then load `icd`
then load `codigo`

``` r
# load package
library(icd)
library(codigo)
```

## Usage
Expand Down Expand Up @@ -130,7 +130,7 @@ which gives the following output:
#> [1] 2
#>
#> $uniqueSearchId
#> [1] "0bed938d-3a23-4553-9591-565525ce74ec"
#> [1] "525bf14f-6ae8-4f42-bac6-ea9e2b9073f6"
#>
#> $words
#> NULL
Expand Down Expand Up @@ -346,11 +346,11 @@ for their intended end use.
## Citation
If you find the `icd` package useful please cite using the suggested
If you find the `codigo` package useful please cite using the suggested
citation provided by a call to the `citation()` function as follows:
``` r
citation("icd")
citation("codigo")
#> To cite icd in publications use:
#>
#> Anita Makori and Ernest Guevarra (2024). icd: Interface to the
Expand All @@ -371,10 +371,10 @@ citation("icd")
## Community guidelines
Feedback, bug reports and feature requests are welcome; file issues or
seek support [here](https://github.com/OxfordIHTM/icd/issues). If you
seek support [here](https://github.com/OxfordIHTM/codigo/issues). If you
would like to contribute to the package, please see our [contributing
guidelines](https://oxford-ihtm.io/icd/CONTRIBUTING.html).
guidelines](https://oxford-ihtm.io/codigo/CONTRIBUTING.html).
This project is released with a [Contributor Code of
Conduct](https://OxfordIHTM/codeditr/CODE_OF_CONDUCT.html). By
Conduct](https://OxfordIHTM/codigo/CODE_OF_CONDUCT.html). By
participating in this project you agree to abide by its terms.
File renamed without changes.
27 changes: 17 additions & 10 deletions docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 34a5f62

Please sign in to comment.