R/dependencies.R

In news-r/gensimr: Topic Modelling

#' Install Dependencies
#' 
#' Install Python dependencies. Arguments are passed to \link[reticulate]{py_install}.
#' 
#' @param envname Name of environment to install packages into
#' @param method Installation method. By default, "auto" automatically 
#' finds a method that will work in the local environment. 
#' Change the default to force a specific installation method. 
#' Note that the "virtualenv" method is not available on Windows.
#' @param conda Path to conda executable (or "auto" to find conda using the
#' \code{PATH} and other conventional install locations).
#' 
#' @section Dependencies:
#' \itemize{
#'   \item{gensim - The core library.}
#'   \item{scikit-learn - Gensim has a Scikit-learn API.}
#'   \item{pyLDAvis - Module to visualise Latent Dirichlet Allocation models.}
#' }
#' 
#' @details \code{\link{install_dependencies}} is a wrapper to install all dependencies at once.
#' 
#' @examples
#' \dontrun{install_dependencies()}
#' 
#' @import assertthat
#' @importFrom graphics points
#' 
#' @name dependencies
#' @export
install_dependencies <- function(envname = NULL, method = "auto", conda = "auto") {
  install_gensim(envname = envname, method = method, conda = conda)
  install_sklearn(envname = envname, method = method, conda = conda)
  install_ldavis(envname = envname, method = method, conda = conda)
}

#' @rdname dependencies
#' @export
install_gensim <- function(envname = NULL, method = "auto", conda = "auto") {
  reticulate::py_install("gensim", envname = envname, method = method, conda = conda)
}

#' @rdname dependencies
#' @export
install_sklearn <- function(envname = NULL, method = "auto", conda = "auto") {
  reticulate::py_install("scikit-learn", envname = envname, method = method, conda = conda)
}

#' @rdname dependencies
#' @export
install_ldavis <- function(envname = NULL, method = "auto", conda = "auto") {
  reticulate::py_install("pyLDAvis", envname = envname, method = method, conda = conda)
}