Skip to content

trichelab/FileSetExperiment

Repository files navigation

output
github_document

FileSetExperiment

GitHub issues GitHub pulls Lifecycle: experimental Bioc release status Bioc devel status Bioc downloads rank Bioc support Bioc history Bioc last commit Bioc dependencies check-bioc Codecov test coverage

The goal of FileSetExperiment is to wrap sesame fileSet objects into a SummarizedExperiment-like object, with the corresponding expected features.

Installation instructions

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

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

BiocManager::install("FileSetExperiment")

And the development version from GitHub with:

BiocManager::install("trichelab/FileSetExperiment")

Example

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

library("FileSetExperiment")
## basic example code

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:

plot of chunk pressure

plot of chunk pressure

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

print(citation('FileSetExperiment'), bibtex = TRUE)
#> Error in .bibentry_check_bibentry1(rval): A bibentry of bibtype 'Manual' has to specify the field: title

Please note that the FileSetExperiment 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 FileSetExperiment project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Development tools

For more details, check the dev directory.

This package was developed using biocthis.

About

A rectangular FileSet-backed object with rowData and colData

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published