| toOrdinal {toOrdinal} | R Documentation |
Cardinal to ordinal number conversion function
Description
Function for converting cardinal to ordinal numbers by adding a language specific ordinal indicator (http://en.wikipedia.org/wiki/Ordinal_indicator) to the number.
Usage
toOrdinal(
cardinal_number,
language="English",
convert_to="ordinal_number")
Arguments
cardinal_number |
Postive integer (cardinal number) to be converted to an ordinal number. For example 1 becomes 1st, 2 becomes 2nd, ... |
language |
OPTIONAL. Language (defaults to English) indicating what language rules to use in conversion to ordinal number. |
convert_to |
OPTIONAL. Output type that provided 'cardinal_number' is converted into. Default is 'ordinal_number' which refers to the 'cardinal_number' followed by the appropriate ordinal indicator. Additional options planned include 'ordinal_word'. |
Details
Typical use of the function is to submit a positive integer for conversion to an ordinal number in the language specified. See examples.
Value
Function returns the ordinal number or ordinal word (as a character string).
Author(s)
Damian W. Betebenner dbetebenner@nciea.org
Examples
toOrdinal(1) ## 1st
toOrdinal(1, language="French") ## 1re
toOrdinal(1:20) ## 1st, 2nd, 3rd, ...
toOrdinal(1:25, language="French") ## 1re, 2e, 3e, ...