Package 'HanNLP'

Description

Backup the writable HanNLP user dictionary.

Usage

backupUsrDic(ask = TRUE)

Arguments

Details

Before writing dictionary files, explicitly set the environment variable HANNLP_USER_DATA_DIR to the desired directory. There is no default writable directory. Backups are stored in its ‘backup’ subdirectory. For temporary use, choose a directory under tempdir().

Value

invisible logical

Description

Build the writable HanNLP user dictionary from user-supplied entries and optional external sources. The Sejong dictionary is read from the installed Sejong package or the path specified by HANNLP_SEJONG_HANDIC. The woorimalsam and insighter dictionaries require the optional NIADic package to be installed and loaded (library(NIADic)) in the current session; HanNLP does not bundle NIADic data.

Usage

buildDictionary(
  ext_dic = "",
  category_dic_nms = "",
  user_dic = data.frame(),
  replace_usr_dic = FALSE,
  verbose = FALSE
)

Arguments

Details

Before writing dictionary files, explicitly set the environment variable HANNLP_USER_DATA_DIR to the desired directory. There is no default writable directory. Backups are stored in its ‘backup’ subdirectory. For temporary use, choose a directory under tempdir().

Value

invisible data.frame of the resulting user dictionary

Description

Return concordance text for an input file.

Usage

concordance_file(filename, pattern, encoding = getOption("encoding"), span = 5)

Arguments

Value

character vector of matched concordance strings

Description

Return concordance text for an input pattern and span.

Usage

concordance_str(string, pattern, span = 5)

Arguments

Value

list of matched concordance strings, with empty elements removed

Description

Convert Hangul syllables to compatibility Jamo sequences.

Usage

convertHangulStringToJamos(hangul)

Arguments

Value

Jamo sequences

Examples

hangul <- intToUtf8(c(0xd55c, 0xae00))
convertHangulStringToJamos(hangul)

Description

Convert Hangul syllables to two-beolsik keystroke sequences.

Usage

convertHangulStringToKeyStrokes(hangul, isFullwidth = TRUE)

Arguments

Value

Keystroke sequence

Description

Convert tags between KAIST and Sejong tag sets.

Usage

convertTag(fromTag, toTag, tag)

Arguments

Value

converted tag vector

Examples

convertTag("K", "S", "ncn")

Description

KoNLP-compatible edit weight metadata. HanNLP does not use this table in runtime algorithms yet.

Format

A 66 by 66 numeric matrix of edit (substitution) costs indexed by keystroke characters on both dimensions.

Value

A 66 by 66 numeric matrix of keystroke edit costs.

Source

Derived from the edit weight table distributed with 'KoNLP'.

Description

Extract nouns from Korean sentences using the native HanNLP analyzer backend.

Usage

extractNoun(sentences, autoSpacing = FALSE)

Arguments

Value

character vector for one sentence, list for multiple sentences

Examples

local({
  old <- Sys.getenv("HANNLP_USER_DATA_DIR", unset = NA)
  tmp <- tempfile("hannlp-user-data-")
  on.exit({
    if (is.na(old)) Sys.unsetenv("HANNLP_USER_DATA_DIR") else Sys.setenv(HANNLP_USER_DATA_DIR = old)
    unlink(tmp, recursive = TRUE, force = TRUE)
  })
  Sys.setenv(HANNLP_USER_DATA_DIR = tmp)
  text <- intToUtf8(c(0xd55c, 0xae00, 0x20, 0xd615, 0xd0dc, 0xc18c))
  extractNoun(text)
})

Description

Return a HanNLP dictionary as a data.frame. The external Sejong dictionary requires an installed source package or a configured file path. The NIADic-based dictionaries require the loaded optional NIADic package.

Usage

get_dictionary(dic_name)

Arguments

Value

data.frame with dictionary terms and tags

Description

Compose complete Hangul syllables from compatibility Jamo or two-beolsik keystroke sequences.

Usage

HangulAutomata(input, isKeystroke = FALSE, isForceConv = FALSE)

Arguments

Value

complete Hangul syllable string

Description

Check whether each input string contains only ASCII characters.

Usage

is.ascii(sentence)

Arguments

Value

logical vector

Description

Check whether each input string contains only Hangul syllables or compatibility Jamo.

Usage

is.hangul(sentence)

Arguments

Value

logical vector

Examples

hangul <- intToUtf8(c(0xd55c, 0xae00))
is.hangul(c(hangul, "abc"))

Description

Check whether each input string contains only Korean consonant Jamo.

Usage

is.jaeum(sentence)

Arguments

Value

logical vector

Description

Check whether each input string contains only compatibility Jamo.

Usage

is.jamo(sentence)

Arguments

Value

logical vector

Description

Check whether each input string contains only Korean vowel Jamo.

Usage

is.moeum(sentence)

Arguments

Value

logical vector

Description

KoNLP-compatible mapping from KAIST tags to Sejong tags.

Format

A named character vector whose names are KAIST tag names and whose values are the corresponding Sejong tag names.

Value

A named character vector mapping KAIST tags to Sejong tags.

Source

Derived from the tag mapping distributed with 'KoNLP'.

Description

Append to or replace the writable HanNLP user dictionary.

Usage

mergeUserDic(newUserDic, append = TRUE, verbose = FALSE, ask = FALSE)

Arguments

Details

Before writing dictionary files, explicitly set the environment variable HANNLP_USER_DATA_DIR to the desired directory. There is no default writable directory. Backups are stored in its ‘backup’ subdirectory. For temporary use, choose a directory under tempdir().

Value

invisible data.frame of the resulting user dictionary

Description

Analyze Korean sentences using the native HanNLP analyzer backend.

Usage

MorphAnalyzer(sentences, autoSpacing = FALSE)

Arguments

Value

named list of eojeol to morpheme/tag strings for one sentence, list for multiple sentences

Examples

text <- intToUtf8(c(0xd55c, 0xae00, 0x20, 0xd615, 0xd0dc, 0xc18c))
MorphAnalyzer(text)

Description

Return mutual information or t-scores for adjacent word bigrams.

Usage

mutualinformation(text, query = "", method = c("mutual", "tscores"))

Arguments

Value

named numeric vector

Description

HanNLP loads dictionaries per analysis call, so this function is retained for KoNLP API compatibility.

Usage

reloadAllDic()

Value

invisible TRUE

Description

Compatibility wrapper for reloading user dictionaries.

Usage

reloadUserDic(whichDics)

Arguments

Value

invisible TRUE

Description

Restore the writable HanNLP user dictionary from backup.

Usage

restoreUsrDic(ask = TRUE)

Arguments

Details

Before writing dictionary files, explicitly set the environment variable HANNLP_USER_DATA_DIR to the desired directory. There is no default writable directory. Backups are stored in its ‘backup’ subdirectory. For temporary use, choose a directory under tempdir().

Value

invisible logical

Description

Tag Korean sentences using 9 KAIST tags with the native HanNLP analyzer backend.

Usage

SimplePos09(sentences, autoSpacing = FALSE)

Arguments

Value

named list of eojeol to morpheme/tag strings for one sentence, list for multiple sentences

Description

Tag Korean sentences using 22 KAIST tags with the native HanNLP analyzer backend.

Usage

SimplePos22(sentences, autoSpacing = FALSE)

Arguments

Value

named list of eojeol to morpheme/tag strings for one sentence, list for multiple sentences

Description

Show summary, head, and tail of current or backup user dictionaries.

Usage

statDic(which = "current", n = 6)

Arguments

Value

list containing summary, head, and tail

Description

KoNLP-compatible mapping from Sejong tags to KAIST tags.

Format

A named character vector whose names are Sejong tag names and whose values are the corresponding KAIST tag names.

Value

A named character vector mapping Sejong tags to KAIST tags.

Source

Derived from the tag mapping distributed with 'KoNLP'.

Description

KoNLP-compatible KAIST/HanNanum tag names used by HanNLP dictionary utilities.

Format

A named character vector mapping each supported tag name to itself, used to validate tag entries.

Value

A named character vector of supported tag names.

Source

Derived from the KAIST/HanNanum tag set distributed with 'KoNLP'.

Description

Replace the writable user dictionary with NIADic entries. HanNLP does not bundle or distribute NIADic data because it is released under CC BY-SA, which is incompatible with the GPL. This function works only when the optional NIADic package is installed and its namespace is already loaded in the current R session (e.g. after library(NIADic)); otherwise it errors.

Usage

useNIADic(
  which_dic = c("woorimalsam", "insighter"),
  category_dic_nms = "all",
  backup = TRUE
)

Arguments

Details

Before writing dictionary files, explicitly set the environment variable HANNLP_USER_DATA_DIR to the desired directory. There is no default writable directory. Backups are stored in its ‘backup’ subdirectory. For temporary use, choose a directory under tempdir().

Value

invisible data.frame of the resulting user dictionary

Description

Replace the writable user dictionary with Sejong dictionary entries from an installed Sejong package or HANNLP_SEJONG_HANDIC.

Usage

useSejongDic(backup = TRUE)

Arguments

Details

Before writing dictionary files, explicitly set the environment variable HANNLP_USER_DATA_DIR to the desired directory. There is no default writable directory. Backups are stored in its ‘backup’ subdirectory. For temporary use, choose a directory under tempdir().

Value

invisible result

Description

Restore the writable user dictionary to HanNLP's bundled default user dictionary.

Usage

useSystemDic(backup = TRUE)

Arguments

Details

Before writing dictionary files, explicitly set the environment variable HANNLP_USER_DATA_DIR to the desired directory. There is no default writable directory. Backups are stored in its ‘backup’ subdirectory. For temporary use, choose a directory under tempdir().

Value

invisible TRUE