R/loaders.R

In morphemepiece.data: Data for Morpheme Tokenization

# Copyright 2021 Bedford Freeman & Worth Pub Grp LLC DBA Macmillan Learning.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

#' Load a Morphemepiece Vocabulary
#'
#' A morphemepiece vocabulary is a named integer vector with class
#' "morphemepiece_vocabulary". The names of the vector are the morphemes, and
#' the values are the integer identifiers of those tokens. The vocabulary is
#' 0-indexed for compatibility with Python implementations.
#'
#' @return A morphemepiece_vocabulary.
#' @export
#'
#' @examples
#' head(morphemepiece_vocab())
morphemepiece_vocab <- function() {
  return(
    .load_inst_rds("vocab", 30000L)
  )
}

#' Load a Morphemepiece Lookup
#'
#' A morphemepiece lookup is a named character vector. The names of the vector
#' are the words, and the values are the space-separated morpheme breakdowns of
#' those words.
#'
#' @return A named character vector.
#' @export
#'
#' @examples
#' head(morphemepiece_lookup())
morphemepiece_lookup <- function() {
  return(
    .load_inst_rds("lookup", 30000L)
  )
}

#' Load an RDS from inst Dir
#'
#' @inheritParams .get_path
#'
#' @return The R object.
#' @keywords internal
.load_inst_rds <- function(filetype, n_tokens) {
  return(readRDS(.get_path(filetype, n_tokens)))
}

#' Generate the inst path
#'
#' @param filetype Character scalar; the type of file, like "lookup" or "vocab".
#' @param n_tokens Integer scalar; The number of tokens used for that file.
#'
#' @return Character scalar; the path to the file.
#' @keywords internal
.get_path <- function(filetype, n_tokens) {
  return(
    system.file(
      "rds",
      paste0(
        paste(
          "morphemepiece",
          filetype,
          n_tokens,
          sep = "_"
        ),
        ".rds"
      ),
      package = "morphemepiece.data"
    )
  )
}