R/quickModel.R

In bigml: Bindings for the BigML API

#' Quickly Creating BigML Models
#' @export
#' @family model methods
#' @references \url{https://bigml.com/developers/models}
#' @family quick methods
#' @param data A matrix or data frame containing data to upload to bigml.
#' @param input_fields A vector of string names to use for training.
#' @param objective_fields A single string value to use as an objective field
#'	(objective_fields is plural for future use).
#' @param name A string giving the name of the model.
#' @param range A two element numeric vector that defines a range over
#'	the dataset in which to train on.
#' @template dots
#' @template model_return
#' @details quickModel will take its "data" dataframe argument and attempt
#' 	to create a dataset using \code{\link{quickDataset}}.  It is possible to
#'	specify the input_fields and objective_fields using the simple names from
#'	the \code{data} argument.
#' @template author
quickModel <-
function (data, input_fields = names(data), objective_fields = tail(names(data),
    n = 1), name = paste(deparse(substitute(data)), "'s model",
    sep = ""), range = NULL, ...)
{
    dresponse = quickDataset(data)
    option = list()
    option$dataset = dresponse$resource
    if (!is.null(range))
        option$range = range
    input_field_ids = NULL
    if (!is.null(input_fields) && !all(input_fields == names(data))) {
        input_field_ids = sapply(input_fields, function(x) {
            id = .resolve_field_id(x, dresponse$fields)
            if (id == NULL) {
                stop(paste("input field is not in dataframe:",
                  x))
            }
            return(id)
        })
        input_field_ids = as.vector(input_field_ids)
    }
    if (!is.null(input_field_ids))
        option$input_fields = input_field_ids

    message("Model creation in progress...")
    return(.basic_api(.MODEL_URL)$postJson(option, ...))
}