mirror of
https://github.com/msberends/AMR.git
synced 2026-03-19 15:42:27 +01:00
37 lines
1.7 KiB
R
37 lines
1.7 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/amr_course.R
|
|
\name{amr_course}
|
|
\alias{amr_course}
|
|
\title{Download and Unpack an AMR Course Repository}
|
|
\usage{
|
|
amr_course(github_repo, branch = "main", ...)
|
|
}
|
|
\arguments{
|
|
\item{github_repo}{A character string specifying the GitHub repository with username and repo name, e.g. \code{"https://github.com/username/repo"}.}
|
|
|
|
\item{branch}{A character string specifying the branch to download. Defaults to \code{"main"}.}
|
|
|
|
\item{...}{Additional arguments passed on to \code{\link[usethis:zip-utils]{usethis::use_course()}}.}
|
|
}
|
|
\value{
|
|
Called for its side effect. \code{\link[usethis:zip-utils]{usethis::use_course()}} will prompt the user to choose a destination and open the extracted project. Returns invisibly whatever \code{\link[usethis:zip-utils]{usethis::use_course()}} returns.
|
|
}
|
|
\description{
|
|
Downloads and unpacks a GitHub repository containing course materials, using \code{\link[usethis:zip-utils]{usethis::use_course()}}. This is a convenience wrapper intended for use in educational settings, such as workshops or tutorials associated with the AMR package.
|
|
}
|
|
\details{
|
|
This function constructs a ZIP archive URL from the provided \code{github_repo} and \code{branch}, then delegates to \code{\link[usethis:zip-utils]{usethis::use_course()}} to handle the download and extraction.
|
|
|
|
The function is designed for interactive use in course or workshop settings and is not intended for use in non-interactive or automated pipelines.
|
|
}
|
|
\examples{
|
|
\dontrun{
|
|
|
|
# Let this run by users, e.g., webinar participants
|
|
amr_course("https://github.com/my_user_name/our_AMR_course")
|
|
}
|
|
}
|
|
\seealso{
|
|
\code{\link[usethis:zip-utils]{usethis::use_course()}}
|
|
}
|