Description Usage Arguments Details Value Examples
View source: R/use_bioc_description.R
This function is very similar to usethis::use_description()
except
that it uses a template from biocthis
. This template includes some of the
information expected in the DESCRIPTION file of a Bioconductor package. You
can compare the output of this function to the one from
usethis::use_description()
to select the parts you want from each.
1 | use_bioc_description(biocViews = "Software", report_bioc = TRUE)
|
biocViews |
A |
report_bioc |
A |
For details about the DESCRIPTION file guidelines for Bioconductor packages check http://bioconductor.org/developers/package-guidelines/#description.
This function adds and/or replaces the DESCRIPTION
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
use_bioc_description()
## End(Not run)
## Create an example package for illustrative purposes.
## Note: you do not need to run this for your own package!
pkgdir <- biocthis_example_pkg(use_git = TRUE)
## Create a template DESCRIPTION file that is Bioconductor-friendly
biocthis::use_bioc_description()
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.