-
-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathREADME.Rmd
119 lines (96 loc) · 3.4 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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r}
#| echo: false
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
if (file.exists("man/figures/nacho_app.mp4")) {
system("ffmpeg -i man/figures/nacho_app.mp4 -vf fps=1 man/figures/nacho_app%04d.png")
gif_app <- gifski::gifski(
png_files = list.files(
path = dirname(knitr::opts_chunk$get("fig.path")),
pattern = "nacho_app.*.png",
full.names = TRUE
),
gif_file = paste0(knitr::opts_chunk$get("fig.path"), "nacho_app.gif"),
width = 1920 * 2 / 3,
height = 1080 * 2 / 3,
delay = 0.50,
loop = TRUE,
progress = FALSE
)
unlink(list.files(
path = dirname(knitr::opts_chunk$get("fig.path")),
pattern = "nacho_app.*.png",
full.names = TRUE
))
}
if (file.exists(paste0(knitr::opts_chunk$get("fig.path"), "nacho_app.gif"))) {
gif_app <- paste0(knitr::opts_chunk$get("fig.path"), "nacho_app.gif")
} else {
gif_app <- paste0(knitr::opts_chunk$get("fig.path"), "app.png")
}
```
# NAnostring quality Control dasHbOard <img src="man/figures/nacho_hex.png" align="right" width="120" />
<!-- badges: start -->
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![GitHub tag](https://img.shields.io/github/tag/mcanouil/NACHO.svg?label=latest tag&include_prereleases)](https://github.com/mcanouil/NACHO)
[![codecov](https://codecov.io/gh/mcanouil/NACHO/branch/main/graph/badge.svg)](https://app.codecov.io/gh/mcanouil/NACHO?branch=main)
[![R-CMD-check](https://github.com/mcanouil/NACHO/workflows/R-CMD-check/badge.svg)](https://github.com/mcanouil/NACHO/actions)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version-ago/NACHO)](https://cran.r-project.org/package=NACHO)
[![cran checks_worst](https://badges.cranchecks.info/worst/NACHO.svg)](https://cran.r-project.org/web/checks/check_results_NACHO.html)
[![CRAN_Download_total](https://cranlogs.r-pkg.org/badges/NACHO)](https://cran.r-project.org/package=NACHO)
<!-- badges: end -->
## Installation
```{r}
#| eval: false
# Install NACHO from CRAN:
install.packages("NACHO")
# Or the development version from GitHub:
# install.packages("remotes")
remotes::install_github("mcanouil/NACHO")
```
## Overview
```{r}
#| echo: false
#| results: asis
cat(readLines(file.path("inst", "app", "www", "about-nacho.md"))[-c(1, 2)], sep = "\n")
```
### Shiny Application ([demo](https://mcanouil.shinyapps.io/NACHO_data/))
```{r}
#| eval: false
shiny::runApp(system.file("app", package = "NACHO"))
```
```{r}
#| echo: false
knitr::include_graphics(sub(".*/man", "man", gif_app))
```
```{r}
#| eval: false
visualise(GSE74821)
```
![](man/figures/README-visualise.png)
## Citing NACHO
```{r}
#| echo: false
#| results: asis
print(citation("NACHO"), "html")
```
```{r}
#| echo: false
#| comment: ""
print(citation("NACHO"), "bibtex")
```
---
## Getting help
If you encounter a clear bug, please file a minimal reproducible example on [github](https://github.com/mcanouil/NACHO/issues).
For questions and other discussion, please contact the package maintainer.
## Code of Conduct
Please note that this 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.