Skip to content

Commit

Permalink
changed to 0.5.2
Browse files Browse the repository at this point in the history
  • Loading branch information
RodrigoZepeda committed Jul 25, 2024
1 parent 888063b commit 3cf2401
Show file tree
Hide file tree
Showing 54 changed files with 115 additions and 93 deletions.
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@
^codecov\.yml$
^\.github$
^vignettes/articles$
^_pkgdown\.yml
^\.Rhistory
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: WHOicd
Title: Retrieve data from the World Health Organization (WHO) International Classification of Diseases (ICD) API version 2
Version: 0.5.1
Version: 0.5.2
Authors@R:
person("Rodrigo", "Zepeda-Tello", , "rzepeda17@gmail.com", role = c("aut", "cre"),
comment = c(ORCID = "0000-0003-4471-5270"))
Expand Down
6 changes: 6 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# WHOicd 0.5.2

* Added the site links to `DESCRIPTION`.
* Changed website version to bootstrap v5.
* Removed history from package.

# WHOicd 0.5.1

* Stopped exporting functions to `code_place` and `code_maternal`.
Expand Down
17 changes: 15 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,15 @@ token <- get_token(CLIENT_ID, CLIENT_SECRET)
There are three main objectives for this package:

1. Use of the DORIS system to obtain underlying cause of death.
1. Use of the DORIS system to obtain underlying cause of death from death certificate information.
2. [Use of ICD-11 to codify causes of death](https://rodrigozepeda.github.io/WHOicd/articles/ICD-11.html).
3. [Use of ICD-10 to search for causes of death](https://rodrigozepeda.github.io/WHOicd/articles/ICD-10.html).

## DORIS (WHO Digital Open Rule Integrated Cause of Death Selection)

The [Digital Open Rule Integrated Cause of Death Selection](https://icd.who.int/doris/en), DORIS,
provides a framework for obtaining the underlying cause of death from a death certificate. DORIS
functionality has been implemented in the `doris` function.
functionality has been implemented in the `doris()` function.

The following example considers a 60 year old female whose primary cause of death was `2D42`:
`Malignant neoplasms of ill-defined sites` due to `2E03`: `Malignant neoplasm metastasis in bone or bone marrow` due to `CB41.0Z`: `Acute respiratory failure, unspecified`.
Expand Down Expand Up @@ -108,19 +108,32 @@ Additional information on ICD-11 can be found in the [ICD-11 article](https://ro
The main function relating to ICD-10 is `icd10_search()` which searches for the titles and parents of codes, blocks of chapters. As an example, we can search for the following vector and obtain a `data.frame`:

```{r}
#| results: false
#Search for code, specific code, chapter and block
codes <- c("D60", "IX", "I10-I15")
icd10_search(token, codes)
```

```{r}
#| echo: false
icd10_search(token, codes) |> tibble::as_tibble()
```

If you only want to get the title of the current code/chapter/block you can use `icd10_title` which is faster as it requires less requests to the API:

```{r}
#| results: false
#Search for code, specific code, chapter and block
codes <- c("D60", "IX", "I10-I15")
icd10_title(token, codes)
```

```{r}
#| echo: false
#Search for code, specific code, chapter and block
icd10_title(token, codes) |> tibble::as_tibble()
```

Additional information on ICD-10 can be found in the [ICD-10 article](https://rodrigozepeda.github.io/WHOicd/articles/ICD-10.html)

## Support
Expand Down
35 changes: 17 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ token <- get_token(CLIENT_ID, CLIENT_SECRET)
There are three main objectives for this package:

1. Use of the DORIS system to obtain underlying cause of death.
1. Use of the DORIS system to obtain underlying cause of death from
death certificate information.
2. [Use of ICD-11 to codify causes of
death](https://rodrigozepeda.github.io/WHOicd/articles/ICD-11.html).
3. [Use of ICD-10 to search for causes of
Expand All @@ -63,7 +64,7 @@ There are three main objectives for this package:
The [Digital Open Rule Integrated Cause of Death
Selection](https://icd.who.int/doris/en), DORIS, provides a framework
for obtaining the underlying cause of death from a death certificate.
DORIS functionality has been implemented in the `doris` function.
DORIS functionality has been implemented in the `doris()` function.

The following example considers a 60 year old female whose primary cause
of death was `2D42`: `Malignant neoplasms of ill-defined sites` due to
Expand Down Expand Up @@ -152,20 +153,15 @@ we can search for the following vector and obtain a `data.frame`:
#Search for code, specific code, chapter and block
codes <- c("D60", "IX", "I10-I15")
icd10_search(token, codes)
#> searched code code_title block
#> 1 D60 D60 Acquired pure red cell aplasia [erythroblastopenia] D60-D64
#> 2 IX <NA> <NA> <NA>
#> 3 I10-I15 <NA> <NA> I10-I15
#> block_title chapter
#> 1 Aplastic and other anaemias III
#> 2 <NA> IX
#> 3 Hypertensive diseases IX
#> chapter_title
#> 1 Diseases of the blood and blood-forming organs and certain disorders involving the immune mechanism
#> 2 Diseases of the circulatory system
#> 3 Diseases of the circulatory system
```

#> # A tibble: 3 × 7
#> searched code code_title block block_title chapter chapter_title
#> <chr> <chr> <chr> <chr> <chr> <chr> <chr>
#> 1 D60 D60 Acquired pure red cell… D60-… Aplastic a… III Diseases of …
#> 2 IX <NA> <NA> <NA> <NA> IX Diseases of …
#> 3 I10-I15 <NA> <NA> I10-… Hypertensi… IX Diseases of …

If you only want to get the title of the current code/chapter/block you
can use `icd10_title` which is faster as it requires less requests to
the API:
Expand All @@ -174,12 +170,15 @@ the API:
#Search for code, specific code, chapter and block
codes <- c("D60", "IX", "I10-I15")
icd10_title(token, codes)
#> searched title
#> 1 D60 Acquired pure red cell aplasia [erythroblastopenia]
#> 2 IX Diseases of the circulatory system
#> 3 I10-I15 Hypertensive diseases
```

#> # A tibble: 3 × 2
#> searched title
#> <chr> <chr>
#> 1 D60 Acquired pure red cell aplasia [erythroblastopenia]
#> 2 IX Diseases of the circulatory system
#> 3 I10-I15 Hypertensive diseases

Additional information on ICD-10 can be found in the [ICD-10
article](https://rodrigozepeda.github.io/WHOicd/articles/ICD-10.html)

Expand Down
2 changes: 1 addition & 1 deletion docs/404.html

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

2 changes: 1 addition & 1 deletion docs/LICENSE-text.html

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

2 changes: 1 addition & 1 deletion docs/LICENSE.html

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

2 changes: 1 addition & 1 deletion docs/articles/Generating-your-token.html

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

2 changes: 1 addition & 1 deletion docs/articles/ICD-10.html

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

2 changes: 1 addition & 1 deletion docs/articles/ICD-11.html

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

2 changes: 1 addition & 1 deletion docs/articles/index.html

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

6 changes: 3 additions & 3 deletions docs/authors.html

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

Loading

0 comments on commit 3cf2401

Please sign in to comment.