projr_restore.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/restore-repo.R, R/restore.R
\name{projr_restore_repo}
\alias{projr_restore_repo}
\alias{projr_restore_repo_wd}
\alias{projr_restore}
\title{Restore project artefact directories}
\usage{
projr_restore_repo(
  repo,
  path = NULL,
  label = NULL,
  pos = NULL,
  type = NULL,
  title = NULL
)

projr_restore_repo_wd(repo, label = TRUE)

projr_restore(label = NULL, pos = NULL, type = NULL, title = NULL)
}
\arguments{
\item{repo}{character. GitHub repository (\code{"owner/repo"} or \code{"repo"}).
(Only for repository restoration functions.)}

\item{path}{character. Local path for cloning the repository. Default is \code{NULL},
creating a subdirectory named after the repo. \code{"."} restores directly into the current directory.}

\item{label}{character vector. Specifies labels of artefacts to restore.
Default is \code{NULL}, restoring all \code{raw} artefacts (e.g. \code{raw-data}).}

\item{pos}{character vector. Specifies preferred source: \code{"source"} (directories)
or \code{"dest"} (build). Default is \code{NULL}, checking both.}

\item{type}{character. Remote type: \code{"local"}, \code{"osf"} or \code{"github"}.
Default is \code{NULL}, automatically choosing the first available remote.}

\item{title}{character. Remote title as specified in \verb{_projr.yml}. Default is \code{NULL}.}
}
\value{
Invisibly returns \code{TRUE} if restoration is successful.
}
\description{
Use \code{projr_restore()} to restore all artefacts needed for the current project.
If the project isn't available locally yet,
\code{projr_restore_repo()} will clone it and then restore its artefacts.
}
\details{
\itemize{
\item \code{projr_restore()} restores artefacts in an existing local project without any cloning required.
\item \code{projr_restore_repo()} clones a GitHub repository into a subdirectory (or specified path), then restores artefacts.
\item \code{projr_restore_repo_wd()} clones directly into the current working directory, then restores artefacts.
}
}
\examples{
\dontrun{
  # Restore all artefacts in existing local project
  projr_restore()

  # Clone repository into subdirectory and restore artefacts
  projr_restore_repo("owner/repo")

  # Clone repository into current directory and restore artefacts
  projr_restore_repo_wd("owner/repo")
}

}