cnum: Working with Chinese Numerals

Description

This R package provides useful functions to work with Chinese numerals in R, such as conversion between Chinese numerals and Arabic numerals as well as detection and extraction of Chinese numerals in character objects and string.

Warnings

This package supports conversion of numbers with absolute value not greater than 1e+18. Note that numbers in R are in double precision that carries approximately 16 significant digits. The conversion accuracy for numbers beyond this limit is therefore not guaranteed.

Note

Due to technical limitation, R package documentation cannot contain any non-ASCII characters. Therefore, Chinese characters are represented in romanized Chinese pinyin in the documentation. Visit the GitHub page for examples in Chinese.

Author(s)

Elgar Teo (elgarteo@connect.hku.hk)

See Also

GitHub page: https://github.com/elgarteo/cnum

Chinese Numerals Conversion

Description

Functions to convert between Chinese and Arabic numerals.

Usage

c2num(
  x,
  lang = default_cnum_lang(),
  mode = "casual",
  financial = FALSE,
  literal = FALSE
)

num2c(
  x,
  lang = default_cnum_lang(),
  mode = "casual",
  financial = FALSE,
  literal = FALSE,
  single = FALSE
)

Arguments

Value

c2num returns a numeric vector.

num2c returns a character vector.

Functions

• c2num(): Convert Chinese Numerals to Arabic Numerals.

• num2c(): Convert Arabic Numerals to Chinese Numerals.

Details

The following scale naming systems are supported:

• "casual": the casual naming system used outside of mainland China, i.e. 1e+09 is referred to as "yi zhao".

• "casualPRC": the casual naming system used in mainland China, i.e. 1e+9 is referred to as "yi wanyi".

• "SIprefix": the SI prefix system used in Taiwan as stipulated in the document Names, Definitions and Symbols of the Legal Units of Measurement and the Decimal Multiples and Submultiples.

• "SIprefixPRC": the SI prefix system used in mainland China as stipulated in the document China Statutory Measurement Units.

• "SIprefixPRClong": a variant of "SIprefixPRC" with long prefixes, e.g. 1e+09 is referred to as "yi jika" instead of "yi ji".

Warnings

The modes "casual" and "casualPRC" implements a “myriad scale” with an interval of 1e+04 for large numbers, i.e. "yi" is 10,000 times of "wan", which is different from some of the interval systems used in ancient Chinese writings.

This package supports conversion of numbers with absolute value not greater than 1e+18. Note that numbers in R are in double precision that carries approximately 16 significant digits. The conversion accuracy for numbers beyond this limit is therefore not guaranteed.

References

The standard for mode "SIprefix" Names, Definitions and Symbols of the Legal Units of Measurement and the Decimal Multiples and Submultiples is available from https://gazette.nat.gov.tw/egFront/detail.do?metaid=108965 (in Traditional Chinese).

The standard for mode "SIprefixPRC" The State Council's Order on the Unified Implementation of Legal Measurement Units in Our Country is available from the PRC State Council's website (in Simplified Chinese).

See Also

Functions for detetction and extraction

Examples

c2num("EXAMPLE CHECK")

num2c(721)
num2c(-6)
num2c(3.14)
num2c(721, literal = TRUE)
num2c(1.45e4, financial = TRUE)
num2c(6.85e4, lang = "sc", mode = "casualPRC")
num2c(1.5e4, mode = "SIprefix", single = TRUE)

Default Language for cnum

Description

Function to check the default language for cnum functions.

Usage

default_cnum_lang()

Details

This package supports Traditional Chinese and Simplified Chinese. The language can be specified with the lang parameter in every function, with "tc" for Traditional Chinese and "sc" for Simplified Chinese. The default is "tc", but this can be changed by setting options(cnum.lang = "sc").

Value

The default language for cnum functions.

See Also

• Functions for conversion

• Functions for detetction and extraction

Examples

# Set the default language to Simplified Chinese
options(cnum.lang = "sc")

default_cnum_lang()

Chinese Numerals Detection and Extraction

Description

Functions to detect and extract Chinese numerals in character object and string.

Usage

is_cnum(
  x,
  lang = default_cnum_lang(),
  mode = "casual",
  financial = FALSE,
  literal = FALSE,
  strict = FALSE,
  ...
)

has_cnum(
  x,
  lang = default_cnum_lang(),
  mode = "casual",
  financial = FALSE,
  ...
)

extract_cnum(
  x,
  lang = default_cnum_lang(),
  mode = "casual",
  financial = FALSE,
  prefix = NULL,
  suffix = NULL,
  ...
)

Arguments

Value

is_cnum returns a logical vector indicating is Chinese numerals or not for each element of x).

has_cnum returns a logical vector indicating contains Chinese numerals or not for each element of x.

extract_cnum returns a list of character vectors containing the extracted Chinese numerals.

Functions

• is_cnum(): Test if character object is Chinese numerals. A wrapper around grepl.

• has_cnum(): Test if string contains Chinese numerals. A wrapper around grepl.

• extract_cnum(): Extracts Chinese numerals from string. A wrapper around str_extract_all from stringr.

Details

The following scale naming systems are supported:

• "casual": the casual naming system used outside of mainland China, i.e. 1e+09 is referred to as "yi zhao".

• "casualPRC": the casual naming system used in mainland China, i.e. 1e+9 is referred to as "yi wanyi".

• "SIprefix": the SI prefix system used in Taiwan as stipulated in the document Names, Definitions and Symbols of the Legal Units of Measurement and the Decimal Multiples and Submultiples.

• "SIprefixPRC": the SI prefix system used in mainland China as stipulated in the document China Statutory Measurement Units.

• "SIprefixPRClong": a variant of "SIprefixPRC" with long prefixes, e.g. 1e+09 is referred to as "yi jika" instead of "yi ji".

References

The standard for mode "SIprefix" Names, Definitions and Symbols of the Legal Units of Measurement and the Decimal Multiples and Submultiples is available from https://gazette.nat.gov.tw/egFront/detail.do?metaid=108965 (in Traditional Chinese).

The standard for mode "SIprefixPRC" The State Council's Order on the Unified Implementation of Legal Measurement Units in Our Country is available from the PRC State Council's website (in Simplified Chinese).

See Also

Functions for conversion

Examples

is_cnum("yibai ershiyi")

has_cnum("yibai bashi yuan")

extract_cnum("shisiyi ren")