numberize

Convert words to numbers in English, French and Spanish

https://github.com/epiverse-trace/numberize

Keywords

Repository

Convert words to numbers in English, French and Spanish

README.Rmd

---
output: github_document
---








```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = file.path(c("man", "figures", "README-")),
  out.width = "100%"
)
```

# _{{ packagename }}_ 


[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit)
[![R-CMD-check](https://github.com/{{ gh_repo }}/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/{{ gh_repo }}/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/{{ gh_repo }}/branch/main/graph/badge.svg)](https://app.codecov.io/gh/{{ gh_repo }}?branch=main)
[![lifecycle-{{ recon }}](https://www.reconverse.org/images/badge-{{ recon }}.svg)](https://www.reconverse.org/lifecycle.html#{{ recon }})




_{{ packagename }}_ is an R package to convert numbers written as English, French or Spanish words from `"zero"` to `"nine hundred and ninety nine trillion, nine hundred and ninety nine billion, nine hundred and ninety nine million, nine hundred and ninety nine thousand, nine hundred and ninety nine"` to positive integer values.


_{{ packagename }}_ is developed at the [{{ department }}]({{ department_url }}) at the {{ institution }} as part of the [Epiverse-TRACE program](https://data.org/initiatives/epiverse/).


## Installation

The package can be installed from CRAN using

```r
install.packages("{{packagename}}")
```

### Development version

You can install the development version of _{{ packagename }}_ from
[GitHub](https://github.com/) with:

```{r eval = FALSE}
pak::pak("{{ gh_repo }}")
```

## Example

These examples illustrate the current functionality.

```{r eval=TRUE}
library("numberize")

# numberize a French string
numberize("zéro", lang = "fr")

# numberize a Spanish string
numberize("Siete mil quinientos cuarenta y cinco", lang = "es")

# numberize the English string "nine hundred and ninety-nine trillion, nine hundred and ninety-nine billion, nine hundred and ninety-nine million, nine hundred and ninety-nine thousand, nine hundred and ninety-nine" # nolint: line_length_linter.
formatC(numberize("nine hundred and ninety-nine trillion, nine hundred and ninety-nine billion, nine hundred and ninety-nine million, nine hundred and ninety-nine thousand, nine hundred and ninety-nine"), big.mark = ",", format = "fg") # nolint: line_length_linter.

# some edge cases
numberize("veintiún", lang = "es")
numberize("veintiuno", lang = "es")

# convert a vector of written values
numberize(
  text = c(17, "dix", "soixante-cinq", "deux mille vingt-quatre", NA),
  lang = "fr"
)
```

## Related packages and Limitations
- [`{numberwang}`](https://github.com/coolbutuseless/numberwang) converts numbers to words and vice versa. Limitation: English only, not on CRAN.
- [`{nombre}`](https://CRAN.R-project.org/package=nombre) converts numerics into words. Limitation: English only, no word to number conversion.
- [`{english}`](https://CRAN.R-project.org/package=english) converts numerics into words. Limitation: English only, no word to number conversion.
- [`{spanish}`](https://CRAN.R-project.org/package=spanish) converts numbers to words and vice versa. Limitation: Spanish only.

_{{ packagename }}_ is released as a standalone package in the hope that it will be useful to the R community at large. _{{ packagename }}_ was created in response to data cleaning requirements in [{cleanepi}](https://github.com/epiverse-trace/cleanepi).

### Lifecycle

This package is currently {{ recon }}, as defined by the [RECON software
lifecycle](https://www.reconverse.org/lifecycle.html).

### Contributions

Contributions are welcome via [pull requests](https://github.com/{{ gh_repo }}/pulls).

### Code of Conduct

Please note that the _{{ packagename }}_ project is released with a 
[Contributor Code of Conduct](https://github.com/epiverse-trace/.github/blob/main/CODE_OF_CONDUCT.md).
By contributing to this project, you agree to abide by its terms.

Owner

Citation (CITATION.cff)

# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "numberize" in publications use:'
type: software
license: MIT
title: 'numberize: Convert Words to Numbers in Multiple Languages'
version: 1.0.1
doi: 10.32614/CRAN.package.numberize
abstract: Converts written out numbers into their equivalent numbers. Supports numbers
  written out in English, French, or Spanish.
authors:
- family-names: Gruson
  given-names: Hugo
  email: hugo.gruson+R@normalesup.org
  orcid: https://orcid.org/0000-0002-4094-1476
- family-names: Ahadzie
  given-names: Bankole
  email: bankole.ahadzie@lshtm.ac.uk
repository: https://CRAN.R-project.org/package=numberize
repository-code: https://github.com/epiverse-trace/numberize
url: https://github.com/epiverse-trace/numberize
contact:
- family-names: Ahadzie
  given-names: Bankole
  email: bankole.ahadzie@lshtm.ac.uk
keywords:
- r-package
- r-programming
references:
- type: software
  title: 'R: A Language and Environment for Statistical Computing'
  notes: Depends
  url: https://www.R-project.org/
  authors:
  - name: R Core Team
  institution:
    name: R Foundation for Statistical Computing
    address: Vienna, Austria
  year: '2024'
  version: '>= 3.5.0'
- type: software
  title: spelling
  abstract: 'spelling: Tools for Spell Checking in R'
  notes: Suggests
  url: https://ropensci.r-universe.dev/spelling
  repository: https://CRAN.R-project.org/package=spelling
  authors:
  - family-names: Ooms
    given-names: Jeroen
    email: jeroenooms@gmail.com
    orcid: https://orcid.org/0000-0002-4035-0289
  - family-names: Hester
    given-names: Jim
    email: james.hester@rstudio.com
  year: '2024'
  doi: 10.32614/CRAN.package.spelling
- type: software
  title: testthat
  abstract: 'testthat: Unit Testing for R'
  notes: Suggests
  url: https://testthat.r-lib.org
  repository: https://CRAN.R-project.org/package=testthat
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  year: '2024'
  doi: 10.32614/CRAN.package.testthat
  version: '>= 3.0.0'

GitHub Events

Issues and Pull Requests

Last synced: 6 months ago

Packages