R/dictionary_edit.R

In kbenoit/quanteda.dictionaries: Dictionaries for Text Analysis and Associated Utilities

build_dictionary2 <- quanteda:::build_dictionary2
check_class <- quanteda:::check_class
rebuild_dictionary2 <- quanteda:::rebuild_dictionary2

#' Conveniently edit dictionaries
#'
#' Provides convenient editing of dictionaries, using an interactive editor.
#' @param x a [dictionary] or (list of) character elements
#' @param ... (optional) arguments passed to [utils::edit()] (such as the choice
#'   of editor)
#' @return an edited version of the input object
#' @export
#' @examples
#' # edit the positive and negative entries from the LSD2015
#' \dontrun{
#' my_posneg_dict <- dictionary_edit(data_dictionary_LSD2015[1:2])}
#'
dictionary_edit <- function(x, ...) {
    UseMethod("dictionary_edit")
}

#' @export
dictionary_edit.default <- function(x, ...) {
    check_class(class(x), "dictionary_edit")
}

#' @export
dictionary_edit.dictionary2 <- function(x, ...) {
    x <- as.dictionary(x)
    attrs <- attributes(x)
    x <- build_dictionary2(list_edit(as.list(x), ...))
    x <- rebuild_dictionary2(x, attrs)
    title <- meta(x, "title")
    if (!is.null(title)) meta(x, "title") <- paste(title, "(edited)")
    x
}

#' @rdname dictionary_edit
#' @description
#' `list_edit()` and `char_edit()` provide lower-level convenience functions
#' for interactive editing of (lists of) character objects.  These can be useful
#' for instance in editing stopword lists.
#' @importFrom yaml write_yaml read_yaml
#' @importFrom utils edit
#' @export
list_edit <- function(x, ...) {
    tfile <- tempfile(fileext = ".yml")
    write_yaml(x, file = tfile)
    try(edited <- utils::edit(file = tfile, ...), silent = TRUE)
    read_yaml(tfile)
}

#' @rdname dictionary_edit
#' @export
#' @importFrom stringi stri_write_lines
#' @examples
#' # edit the system stopwords
#' \dontrun{
#' my_stopwords <- stopwords("en", source = "snowball") %>%
#'     char_edit()}
char_edit <- function(x, ...) {
    if (!is.vector(x) || !is.character(x))
        stop("x must be a character vector")
    tfile <- tempfile(fileext = ".txt")
    stri_write_lines(x, fname = tfile)
    try(edited <- utils::edit(file = tfile, ...), silent = TRUE)
    result <- readLines(tfile, encoding = "UTF-8")
    if (result[length(result)] == "")
        result <- result[-length(result)]
    result
}

# possible way to test this:
# https://stackoverflow.com/questions/41372146/test-interaction-with-users-in-r-package