Demonstration On How To Use biocthis At CSHL 2023 • cshl2023pkg

The goal of cshl2023pkg is to …

Installation instructions

Get the latest stable R release from CRAN. Then install cshl2023pkg from Bioconductor using the following code:

if (!requireNamespace("BiocManager", quietly = TRUE)) {
    install.packages("BiocManager")
}

BiocManager::install("cshl2023pkg")

And the development version from GitHub with:

BiocManager::install("lcolladotor/cshl2023pkg")

Example

This is a basic example which shows you how to solve a common problem:

library("cshl2023pkg")
## basic example code

leo()
#> [1] "leo"

What 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.00

You’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('cshl2023pkg') in R. Please run this yourself to check for any updates on how to cite cshl2023pkg.

print(citation("cshl2023pkg"), bibtex = TRUE)
#> To cite package 'cshl2023pkg' in publications use:
#> 
#>   lcolladotor (2023). _Demo CSHL package_.
#>   doi:10.18129/B9.bioc.cshl2023pkg
#>   <https://doi.org/10.18129/B9.bioc.cshl2023pkg>,
#>   https://github.com/lcolladotor/cshl2023pkg/cshl2023pkg - R package
#>   version 0.99.0, <http://www.bioconductor.org/packages/cshl2023pkg>.
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Manual{,
#>     title = {Demo CSHL package},
#>     author = {{lcolladotor}},
#>     year = {2023},
#>     url = {http://www.bioconductor.org/packages/cshl2023pkg},
#>     note = {https://github.com/lcolladotor/cshl2023pkg/cshl2023pkg - R package version 0.99.0},
#>     doi = {10.18129/B9.bioc.cshl2023pkg},
#>   }
#> 
#>   lcolladotor (2023). "Demo CSHL package." _bioRxiv_. doi:10.1101/TODO
#>   <https://doi.org/10.1101/TODO>,
#>   <https://www.biorxiv.org/content/10.1101/TODO>.
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Article{,
#>     title = {Demo CSHL package},
#>     author = {{lcolladotor}},
#>     year = {2023},
#>     journal = {bioRxiv},
#>     doi = {10.1101/TODO},
#>     url = {https://www.biorxiv.org/content/10.1101/TODO},
#>   }

Please note that the cshl2023pkg 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 cshl2023pkg 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, 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.