-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
74 lines (54 loc) · 5.14 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# brainflowprobes
<!-- badges: start -->
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://bioconductor.org/checkResults/release/bioc-LATEST/brainflowprobes)
[](https://bioconductor.org/checkResults/devel/bioc-LATEST/brainflowprobes)
[](http://bioconductor.org/packages/stats/bioc/brainflowprobes/)
[](https://support.bioconductor.org/tag/brainflowprobes)
[](https://bioconductor.org/packages/release/bioc/html/brainflowprobes.html#since)
[](http://bioconductor.org/checkResults/devel/bioc-LATEST/brainflowprobes/)
[](https://bioconductor.org/packages/release/bioc/html/brainflowprobes.html#since)
[](https://codecov.io/gh/LieberInstitute/brainflowprobes?branch=devel)
[](https://github.com/LieberInstitute/brainflowprobes/actions/workflows/check-bioc.yml)
[](https://github.com/LieberInstitute/brainflowprobes/issues)
[](https://github.com/LieberInstitute/brainflowprobes/pulls)
<!-- badges: end -->
This package can be used to annotate candidate target probe sequences designed to label RNA in nuclei isolated from human postmortem brain for flow cytometry. This package also includes functions that visualize candidate sequence expression in four postmortem brain datasets that address nuclear expression, effects of RNA degradation and flow cytometric sorting, and cell type-specific expression to increase the likelihood of success as a custom target probe. Please refer to the BrainFlow publication or the [PrimeFlow RNA(TM) Assay Kit](https://www.thermofisher.com/order/catalog/product/88-18005-204) literature for more information.
## Documentation
For more information about `brainflowprobes` check the vignettes [through Bioconductor](http://bioconductor.org/packages/brainflowprobes) or at the [documentation website](http://lieberinstitute.github.io/brainflowprobes).
## Installation instructions
Get the latest stable `R` release from [CRAN](http://cran.r-project.org/). Then install `brainflowprobes` from [Bioconductor](http://bioconductor.org/) using the following code:
```{r 'install', eval = FALSE}
if (!requireNamespace("BiocManager", quietly = TRUE)) {
install.packages("BiocManager")
}
BiocManager::install("brainflowprobes")
```
## Citation
Below is the citation output from using `citation('brainflowprobes')` in R. Please
run this yourself to check for any updates on how to cite __brainflowprobes__.
```{r 'citation', eval = requireNamespace('brainflowprobes')}
print(citation("brainflowprobes"), bibtex = TRUE)
```
Please note that the `brainflowprobes` 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 derfinderPlot project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
## Development tools
* Continuous code testing is possible thanks to [GitHub actions](https://www.tidyverse.org/blog/2020/04/usethis-1-6-0/) through `r BiocStyle::CRANpkg('usethis')`, `r BiocStyle::CRANpkg('remotes')`, `r BiocStyle::Githubpkg('r-hub/sysreqs')` and `r BiocStyle::CRANpkg('rcmdcheck')` customized to use [Bioconductor's docker containers](https://www.bioconductor.org/help/docker/) and `r BiocStyle::Biocpkg('BiocCheck')`.
* Code coverage assessment is possible thanks to [codecov](https://codecov.io/gh) and `r BiocStyle::CRANpkg('covr')`.
* The [documentation website](http://lieberinstitute.github.io/brainflowprobes) is automatically updated thanks to `r BiocStyle::CRANpkg('pkgdown')`.
* The code is styled automatically thanks to `r BiocStyle::CRANpkg('styler')`.
* The documentation is formatted thanks to `r BiocStyle::CRANpkg('devtools')` and `r BiocStyle::CRANpkg('roxygen2')`.
For more details, check the `dev` directory.