Description Usage Arguments Details Value Examples
View source: R/use_bioc_github_action.R
This function is very similar to usethis::use_github_action()
except
that it uses a template from biocthis
. It creates a Bioconductor-friendly
GitHub action workflow for your package. You can also use this GitHub
Actions workflow by executing usethis::use_github_action()
.
1 2 3 4 5 6 7 8 9 | use_bioc_github_action(
biocdocker,
pkgdown = getOption("biocthis.pkgdown", FALSE),
testthat = getOption("biocthis.testthat", FALSE),
covr = testthat,
RUnit = getOption("biocthis.RUnit", FALSE),
pkgdown_covr_branch = getOption("biocthis.pkgdown_covr_branch", "master"),
docker = getOption("biocthis.docker", FALSE)
)
|
biocdocker |
A |
pkgdown |
A |
testthat |
A |
covr |
A |
RUnit |
A |
pkgdown_covr_branch |
A |
docker |
A |
For the full history on how this GitHub Actions workflow came to be, check the "biocthis developer notes" vignette https://lcolladotor.github.io/biocthis/articles/biocthis_dev_notes.html.
This function adds and/or replaces the
.github/workflows/check-bioc.yml
file in your R package.
1 2 3 4 5 6 7 8 9 10 11 12 | ## Not run:
## Run this function in your package
biocthis::use_bioc_github_action()
## End(Not run)
## I have the following options on my ~/.Rprofile set
## Check
## <https://github.com/lcolladotor/biocthis/issues/9#issuecomment-702401032>
## for more information.
options("biocthis.pkgdown" = TRUE)
options("biocthis.testthat" = TRUE)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.