R/CloneProject.R

In datarobot: 'DataRobot' Predictive Modeling API

#' Clone a project
#'
#' This function clones a project, creating a fresh (post-EDA1) copy that will
#' need a target and modeling options set.
#'
#' @param project dataRobotProject, or a character representing that project's ID.
#' @param newProjectName character. The name of the newly cloned project. If no
#'   name is given, the API will default to 'Copy of \code{project$projectName}'.
#' @param maxWait integer. The maximum time to wait for each of two steps: (1) The initial
#'   project creation request, and (2) data processing that occurs after receiving the response
#'   to this initial request.
#' @inherit as.dataRobotProjectShort return
#' @examples
#' \dontrun{
#'  project <- GetProject("5c1303269300d900016b41a7")
#'  CloneProject(project, newProjectName = "Project Restart")
#' }
#' @export
CloneProject <- function(project,
                         newProjectName = NULL,
                         maxWait = 600) {
    projectId <- ValidateProject(project)

    body <- list()
    body$projectId <- projectId
    body$projectName <- newProjectName
    routeString <- "projectClones/"
    postResponse <- DataRobotPOST(routeString,
                               body = body,
                               returnRawResponse = TRUE,
                               timeout = maxWait)
    message(paste("Project clone of",
                  project$id,
                  "requested"))
    clonedProject <- ProjectFromJobResponse(postResponse,
                                            maxWait = maxWait)
    message(sprintf("Project %s '%s' created from original project %s",
                    clonedProject$projectId,
                    clonedProject$projectName,
                    projectId))
    as.dataRobotProjectShort(clonedProject)
}