bandle
An R package for Bayesian analysis of differential localisation experiments
Science Score: 59.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 5 DOI reference(s) in README -
✓Academic publication links
Links to: biorxiv.org -
✓Committers with academic emails
1 of 3 committers (33.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.7%) to scientific vocabulary
Keywords from Contributors
Repository
An R package for Bayesian analysis of differential localisation experiments
Statistics
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 10
- Releases: 1
Metadata Files
README.md
The bandle package
The bandle (Bayesian Analysis of Differential Localisation Experiments) package is an R/Bioconductor package for analysing differential localisation experiments, include storage, computation, statistics and visulisations.
Installation requirements
Users will require a working version of R, currently at least version >4. It is recommended to use RStudio. The package can then be installed using the Bioconductor or devtools package. The package should take a few minutes to install on a regular desktop or laptop. The package will need to be loaded using library(bandle)
To install the stable Bioconductor release (recommended):
```{r,}
unless BiocManager is already installed
install.packages("BiocManager")
then
BiocManager::install("bandle") ```
Unstable/development package version install:
{r,}
devtools::install_github("ococrook/bandle")
We do not advise you install the unstable version unless you know what you are doing as not all pre-release features may be tested or documented.
Installation troubleshooting
Please make sure you are running the latest version of R. Non-standard library
dependencies may be missing on some operating systems, for example, using
Linux/Ubuntu in a Docker container may requrie the installation of
libxml2-dev, zlib1g-dev, libnetcdf-dev and other libraries. These are
required to install bandle and dependent R packages. These can be installed,
for example if using Linux/Ubuntu using sudo apt install libxml2-dev
or directly from binary e.g. sudo apt install r-cran-xml2.
Basic ideas and concepts
The bandle package implements the BANDLE method for the analysis of comparative/dynamic mass spectrometry based proteomics experiments. Data from form such experiments most commonly yield a matrix of measurements where we have proteins/peptides/peptide spectrum matches (PSMs) along the rows, and samples/fractions along the columns. In comparative/dynamic experiments where we expect re-localisation upon some stimulus to sub-cellular environment, the data analysis is more challenging The BANDLE method takes two (replicated) datasets as input and uses these data to compute the probability that a protein differentially localises upon cellular perturbation, as well quantifying the uncertainty in these estimates.
To use bandle the data must be stored as a list of MSnSet instances, as implemented in the Bioconductor MSnbase package. Please see the relevant vignettes in MSnbase for constructing these data containers.
Vignettes
There are currently two vignettes that accompany the package. The first vignette v01-getting-started provides an introduction to the bandle package and follows a short theortical example of how to perform differential localisation analysis of quantitative proteomics data using the BANDLE model (Crook et al. 2022 doi: https://doi.org/10.1101/2021.01.04.425239). Explanation and general recommendations of the input parameters are provided in this vignette.
The second vignette v02-workflow is a more comprehensive workflow which follows a real-life use case applying the BANDLE methods and workflow to the analysis of data generated from spatial proteomics of a human THP-1 monocyte system.
These vignettes can be found through the Bioconductor landing page for bandle, here in the repo and also the Articles tab of the accompanying web page.
Notes on run time: A small dataset can take around an hour to run; for large dataset we recommend a a compute server. The longest the analysis has taken has been a couple of hours on a single compute node. The demo take a few minutes to run.
Documentation
Documentation to run the main functions can be found in the vignette or by typing ?bandle in the console after loading the package.
We recommend reading our other workflow manuscripts:
Basic processing and machine learning:
https://f1000research.com/articles/5-2926
Bayesian analysis:
https://f1000research.com/articles/8-446
The BANDLE manusript is currently on biorxiv:
https://www.biorxiv.org/content/10.1101/2021.01.04.425239v3
For manuscripts that apply bandle, see:
https://www.biorxiv.org/content/10.1101/2022.01.24.477541v1 https://linkinghub.elsevier.com/retrieve/pii/S1535-9476(22)00002-0
Contribution
Contributions are welcome, please open an issue so we can discuss any contribution in advance.
Feature requests
This package is actively being developed and maintained, please open Github issue if you would like to request or discuss a particular feature.
Owner
- Name: Oliver M. Crook
- Login: ococrook
- Kind: user
- Location: University of Oxford
- Repositories: 21
- Profile: https://github.com/ococrook
Todd-Bird JRF Oxford Statistics. PhD Cambridge. Probabilistic Machine Learning; Bayesian Statistics; Non-Parametrics
GitHub Events
Total
- Issues event: 1
- Delete event: 2
- Push event: 14
- Pull request event: 8
- Create event: 3
Last Year
- Issues event: 1
- Delete event: 2
- Push event: 14
- Pull request event: 8
- Create event: 3
Committers
Last synced: over 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Lisa Breckels | l****9@c****k | 88 |
| Oliver M. Crook | o****k@g****m | 79 |
| Nitesh Turaga | n****a@g****m | 2 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 7 months ago
All Time
- Total issues: 22
- Total pull requests: 10
- Average time to close issues: 8 months
- Average time to close pull requests: about 1 hour
- Total issue authors: 6
- Total pull request authors: 3
- Average comments per issue: 2.55
- Average comments per pull request: 0.2
- Merged pull requests: 9
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 5
- Average time to close issues: N/A
- Average time to close pull requests: 34 minutes
- Issue authors: 1
- Pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 0.0
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- lmsimp (11)
- ococrook (6)
- JosieAC (3)
- melonora (1)
- JoBBurt (1)
- TomSmithCGAT (1)
Pull Request Authors
- lmsimp (9)
- ococrook (4)
- TomSmithCGAT (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- bioconductor 6,465 total
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 5
- Total maintainers: 1
bioconductor.org: bandle
An R package for the Bayesian analysis of differential subcellular localisation experiments
- Homepage: http://github.com/ococrook/bandle
- Documentation: https://bioconductor.org/packages/release/bioc/vignettes/bandle/inst/doc/bandle.pdf
- License: Artistic-2.0
-
Latest release: 1.12.0
published 10 months ago
Rankings
Maintainers (1)
Dependencies
- Biobase * depends
- MSnbase * depends
- R >= 4.1 depends
- S4Vectors * depends
- pRoloc * depends
- BiocParallel * imports
- BiocStyle * imports
- Rcpp >= 1.0.4.6 imports
- circlize * imports
- dplyr * imports
- ggalluvial * imports
- ggplot2 * imports
- ggrepel * imports
- grDevices * imports
- graphics * imports
- knitr * imports
- lbfgs * imports
- methods * imports
- pRolocdata * imports
- plyr * imports
- rlang * imports
- robustbase * imports
- stats * imports
- tidyr * imports
- utils * imports
- coda >= 0.19 suggests
- fields * suggests
- interp * suggests
- pheatmap * suggests
- rmarkdown * suggests
- spelling * suggests
- testthat * suggests
- viridis * suggests
- actions/cache v2 composite
- actions/checkout v2 composite
- actions/upload-artifact master composite
- docker/build-push-action v1 composite
- r-lib/actions/setup-pandoc master composite
- r-lib/actions/setup-r master composite