Skip to content

Latest commit

 

History

History
63 lines (51 loc) · 2.61 KB

README.md

File metadata and controls

63 lines (51 loc) · 2.61 KB
Raw

iSEEbug

issues pulls R-CMD-check codecov codefactor

The goal of iSEEbug is to provide a user-friendly interface to import, build, explore and visualise TreeSummarizedExperiment objects by means of iSEE.

Installation instructions

The devel version of iSEEbug can be installed from GitHub as follows:

remotes::install_github("RiboRings/iSEEbug")

Example

The basic functionality of iSEEbug can be explored as follows:

library(iSEEbug)

app <- iSEEbug()

# Launch iSEE
if (interactive()) {
  shiny::runApp(app)
}

Code of Conduct

Please note that the iSEEbug project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms. Contributions are welcome in the form of feedback, issues and pull requests. You can find the contributor guidelines of the miaverse here.

Acknowledgements

Please note that iSEEbug was only made possible thanks to many other R and bioinformatics software authors, which are cited in the vignettes describing this package.

This package was developed using the following resources:

  • usethis to generate an initial template.
  • Continuous code testing is performed on GitHub actions and include R CMD check, BiocCheck and testthat.
  • Code coverage assessment is possible thanks to codecov.
  • The documentation website is automatically updated thanks to pkgdown.
  • The documentation is formatted thanks to devtools and roxygen2.
  • All the actions above are made reproducible by rworkflows