mirror of
https://github.com/msberends/AMR.git
synced 2026-03-30 05:36:07 +02:00
Built site for AMR@3.0.1.9036: 4171d5b
This commit is contained in:
@@ -1,9 +1,10 @@
|
||||
# Download and Unpack an AMR Course Repository
|
||||
|
||||
Downloads and unpacks a GitHub repository containing course materials,
|
||||
using `usethis::use_course()`. This is a convenience wrapper intended
|
||||
for use in educational settings, such as workshops or tutorials
|
||||
associated with the AMR package.
|
||||
using
|
||||
[`usethis::use_course()`](https://usethis.r-lib.org/reference/zip-utils.html).
|
||||
This is a convenience wrapper intended for use in educational settings,
|
||||
such as workshops or tutorials associated with the AMR package.
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -25,19 +26,24 @@ amr_course(github_repo, branch = "main", ...)
|
||||
|
||||
- ...:
|
||||
|
||||
Additional arguments passed on to `usethis::use_course()`.
|
||||
Additional arguments passed on to
|
||||
[`usethis::use_course()`](https://usethis.r-lib.org/reference/zip-utils.html).
|
||||
|
||||
## Value
|
||||
|
||||
Called for its side effect. `usethis::use_course()` will prompt the user
|
||||
to choose a destination and open the extracted project. Returns
|
||||
invisibly whatever `usethis::use_course()` returns.
|
||||
Called for its side effect.
|
||||
[`usethis::use_course()`](https://usethis.r-lib.org/reference/zip-utils.html)
|
||||
will prompt the user to choose a destination and open the extracted
|
||||
project. Returns invisibly whatever
|
||||
[`usethis::use_course()`](https://usethis.r-lib.org/reference/zip-utils.html)
|
||||
returns.
|
||||
|
||||
## Details
|
||||
|
||||
This function constructs a ZIP archive URL from the provided
|
||||
`github_repo` and `branch`, then delegates to `usethis::use_course()` to
|
||||
handle the download and extraction.
|
||||
`github_repo` and `branch`, then delegates to
|
||||
[`usethis::use_course()`](https://usethis.r-lib.org/reference/zip-utils.html)
|
||||
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
|
||||
@@ -45,7 +51,7 @@ pipelines.
|
||||
|
||||
## See also
|
||||
|
||||
`usethis::use_course()`
|
||||
[`usethis::use_course()`](https://usethis.r-lib.org/reference/zip-utils.html)
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
Reference in New Issue
Block a user