lahuuki/JunePackage
What the Package Does (One Line, Title Case)
JunePackage
The goal of JunePackage is to …
Installation instructions
Get the latest stable R release from
CRAN. Then install JunePackage using
from Bioconductor the following code:
if (!requireNamespace("BiocManager", quietly = TRUE)) {
install.packages("BiocManager")
}
BiocManager::install("JunePackage")And the development version from GitHub with:
BiocManager::install("lahuuki/JunePackage")Example
This is a basic example which shows you how to solve a common problem:
library("JunePackage")
## basic example codeWhat is special about using README.Rmd instead of just README.md?
You can include R chunks like so:
summary(cars)
#> speed dist
#> Min. : 4.0 Min. : 2.00
#> 1st Qu.:12.0 1st Qu.: 26.00
#> Median :15.0 Median : 36.00
#> Mean :15.4 Mean : 42.98
#> 3rd Qu.:19.0 3rd Qu.: 56.00
#> Max. :25.0 Max. :120.00You’ll still need to render README.Rmd regularly, to keep README.md
up-to-date.
You can also embed plots, for example:
In that case, don’t forget to commit and push the resulting figure
files, so they display on GitHub!
Citation
Below is the citation output from using citation('JunePackage') in R.
Please run this yourself to check for any updates on how to cite
JunePackage.
print(citation('JunePackage'), bibtex = TRUE)
#>
#> lahuuki (2020). _Test and Learn Biocthis on JHPCE_. doi:
#> 10.18129/B9.bioc.JunePackage (URL:
#> https://doi.org/10.18129/B9.bioc.JunePackage),
#> https://github.com/lahuuki/JunePackage - R package version 0.99.0,
#> <URL: http://www.bioconductor.org/packages/JunePackage>.
#>
#> A BibTeX entry for LaTeX users is
#>
#> @Manual{,
#> title = {Test and Learn Biocthis on JHPCE},
#> author = {{lahuuki}},
#> year = {2020},
#> url = {http://www.bioconductor.org/packages/JunePackage},
#> note = {https://github.com/lahuuki/JunePackage - R package version 0.99.0},
#> doi = {10.18129/B9.bioc.JunePackage},
#> }
#>
#> lahuuki (2020). "Test and Learn Biocthis on JHPCE." _bioRxiv_. doi:
#> 10.1101/TODO (URL: https://doi.org/10.1101/TODO), <URL:
#> https://www.biorxiv.org/content/10.1101/TODO>.
#>
#> A BibTeX entry for LaTeX users is
#>
#> @Article{,
#> title = {Test and Learn Biocthis on JHPCE},
#> author = {{lahuuki}},
#> year = {2020},
#> journal = {bioRxiv},
#> doi = {10.1101/TODO},
#> url = {https://www.biorxiv.org/content/10.1101/TODO},
#> }Please note that the JunePackage was only made possible thanks to many
other R and bioinformatics software authors, which are cited either in
the vignettes and/or the paper(s) describing this package.
Code of Conduct
Please note that the JunePackage project is released with a
Contributor Code of
Conduct.
By contributing to this project, you agree to abide by its terms.
Development tools
- Continuous code testing is possible thanks to GitHub
actions
through usethis,
remotes,
sysreqs and
rcmdcheck
customized to use Bioconductor’s docker
containers and
BiocCheck. - Code coverage assessment is possible thanks to
codecov and
covr. - The documentation website is
automatically updated thanks to
pkgdown. - The code is styled automatically thanks to
styler. - The documentation is formatted thanks to
devtools and
roxygen2.
For more details, check the dev directory.
This package was developed using
biocthis.