Example R package from Statistical Computing 140.766 • sum776

The goal of sum776 is to …

Installation instructions

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

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

BiocManager::install("sum776")

And the development version from GitHub with:

BiocManager::install("lcolladotor/sum776")

Example

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

library("sum776")
## basic example code

x <- 1:10
y <- rev(x)

## Compute the sum of x + y
my_sum(x, y)
#>  [1] 11 11 11 11 11 11 11 11 11 11

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

print(citation("sum776"), bibtex = TRUE)
#> To cite package 'sum776' in publications use:
#> 
#>   lcolladotor (2023). _sum766_. doi:10.18129/B9.bioc.sum776
#>   <https://doi.org/10.18129/B9.bioc.sum776>,
#>   https://github.com/lcolladotor/sum776/sum776 - R package version
#>   0.99.0, <http://www.bioconductor.org/packages/sum776>.
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Manual{,
#>     title = {sum766},
#>     author = {{lcolladotor}},
#>     year = {2023},
#>     url = {http://www.bioconductor.org/packages/sum776},
#>     note = {https://github.com/lcolladotor/sum776/sum776 - R package version 0.99.0},
#>     doi = {10.18129/B9.bioc.sum776},
#>   }
#> 
#>   lcolladotor (2023). "sum776." _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 = {sum776},
#>     author = {{lcolladotor}},
#>     year = {2023},
#>     journal = {bioRxiv},
#>     doi = {10.1101/TODO},
#>     url = {https://www.biorxiv.org/content/10.1101/TODO},
#>   }

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