The variable word
is the name to be encoded. The variable
maxCodeLen
is the limit on how long the returned name code
should be. The default is 4.
The statcan
algorithm is only defined for inputs over the
standard French alphabet. Non-alphabetical characters are removed
from the string in a locale-dependent fashion. This strips spaces,
hyphens, and numbers. Other letters, such as "<U+00DC>," may be permissible
in the current locale but are unknown to statcan
. For inputs
outside of its known range, the output is undefined and NA
is
returned and a warning
this thrown. If clean
is
FALSE
, statcan
attempts to process the strings. The
default is TRUE
.