diff --git a/R/fork-and-merge.R b/R/fork-and-merge.R index f2de43cc6..bce10ff51 100644 --- a/R/fork-and-merge.R +++ b/R/fork-and-merge.R @@ -29,6 +29,16 @@ forks <- function(dataset) { #' folder as the existing dataset. #' @return The new fork, a `CrunchDataset`. #' @seealso [mergeFork()] +#' @examples +#' \dontrun{ +#' # Defaults to being placed in the same project folder as the original dataset +#' ds_fork <- forkDataset(ds) +#' +#' # But you can specify a project by path, `ProjectFolder` object or URL +#' ds_fork2 <- forkDataset(ds, project = "/Client1/forks/") +#' ds_fork3 <- forkDataset(ds, project = projects()[["My forks"]]) +#' ds_fork4 <- forkDataset(ds, project = "https://app.crunch.io/api/projects/abc") +#' } #' @export forkDataset <- function(dataset, name = defaultForkName(dataset), draft = FALSE, ..., project = folder(dataset)) { ## TODO: add owner field, default to self(me()) diff --git a/man/forkDataset.Rd b/man/forkDataset.Rd index f7f85726b..3f0fbddc0 100644 --- a/man/forkDataset.Rd +++ b/man/forkDataset.Rd @@ -45,6 +45,17 @@ publishing them, so that you don't accidentally send your clients incorrect data. For more on this workflow, see \code{vignette("fork-and-merge", package = "crunch")}. } +\examples{ +\dontrun{ +# Defaults to being placed in the same project folder as the original dataset +ds_fork <- forkDataset(ds) + +# But you can specify a project by path, `ProjectFolder` object or URL +ds_fork2 <- forkDataset(ds, project = "/Client1/forks/") +ds_fork3 <- forkDataset(ds, project = projects()[["My forks"]]) +ds_fork4 <- forkDataset(ds, project = "https://app.crunch.io/api/projects/abc") +} +} \seealso{ \code{\link[=mergeFork]{mergeFork()}} }