stringi (version 0.3-1)

stringi-package: THE String Processing Package

Description

stringi is THE Rpackage for fast, correct, consistent, and convenient string/text manipulation in each locale and any character encoding. We put great effort to create software that gives predictable results on any platform, in each locale, and any ``native'' system encoding.

Keywords: R, text processing, strings, internationalization, localization, ICU, ICU4C, i18n, l10n, Unicode.

Homepage: http://stringi.rexamine.com

License: The BSD-3-clause license for the package code, the ICU license for the accompanying ICU4C distribution, and the UCD license for the Unicode Character Database. See the COPYRIGHTS and LICENSE file for more details.

Facilities available

Refer to the following:

• stringi-searchfor string searching facilities; these include pattern searching, matching, string splitting, and so on. The following independent search engines are provided:
  • stringi-search-regex-- with ICU (Java-like) regular expressions;
  • stringi-search-fixed-- fast, locale-independent, bytewise pattern matching,
  • stringi-search-coll-- locale-aware pattern matching for natural language processing tasks;
  • stringi-search-charclass-- for finding elements of particular character classes, like ``all whitespaces'' or ``all digits'';
  • stringi-search-boundaries-- text boundary analysis.
• stri_stats_generalandstri_stats_latexfor gathering some fancy statistics on a character vector's contents.
• stri_join,stri_dup,%s+%, andstri_flattenfor concatenation-based operations.
• stri_subfor extracting and replacing substrings, andstri_reversefor a joyful function to reverse all code points in a string.
• stri_trim(among others) for trimming characters from the beginning or/and end of a string, see alsostringi-search-charclass, andstri_padfor padding strings so that they have the same minimal number of code points. Additionally,stri_wrapwraps text into lines.
• stri_length(among others) for determining the number of code points in a string. See alsostri_count_boundariesfor counting the number ofUnicode characters.
• stri_trans_tolower(among others) for case mapping, i.e. conversion to lower, UPPER, or Title Case,
• stri_trans_nfc(i.a.) for Unicode normalization, andstri_trans_generalfor other very general yet powerful text transforms, including transliteration.
• stri_cmp,%s<%< a="">,stri_order,stri_sort,stri_uniqueandstri_duplicatedfor collation-based, locale-aware operations, see alsostringi-locale.
• stri_split_lines(among others) to split a string into text lines.
• stri_escape_unicode(among others) for escaping certain code points.
• stri_rand_strings,stri_rand_shuffle, andstri_rand_lipsumfor generating (pseudo)random strings.
• DRAFT API:stri_read_raw,stri_read_lines, andstri_write_linesfor reading and writing text files.
• TO DO [these will appear in future versions ofstringi]: HTML entities, MIME Base 64 encode/decode, number and data/time formatting, number spellout, and many more.

Note that each man page has many links to other interesting facilities.

You are encouraged to call stri_install_check after the package installation or update.

Details

Manual pages on general topics (must-read):

• stringi-encoding-- character encoding issues, including information on encoding management instringi, as well as on encoding detection and conversion.
• stringi-locale-- locale issues, including i.a. locale management and specification instringi, and the list of locale-sensitive operations. In particular, seestri_opts_collatorfor a description of the string collation algorithm, which is used for string comparing, ordering, sorting, case-folding, and searching.
• stringi-arguments-- howstringideals with its functions' arguments.

References

stringi Package homepage, http://stringi.rexamine.com

ICU -- International Components for Unicode, http://www.icu-project.org/

ICU4C API Documentation, http://www.icu-project.org/apiref/icu4c/

The Unicode Consortium, http://www.unicode.org/

UTF-8, a transformation format of ISO 10646 -- RFC 3629, http://tools.ietf.org/html/rfc3629

See Also

Other stringi_general_topics: stringi-arguments; stringi-encoding; stringi-locale; stringi-search-boundaries; stringi-search-charclass; stringi-search-coll; stringi-search-fixed; stringi-search-regex; stringi-search