Skip to content

Commit 980ecc3

Browse files
committed
edited headings
1 parent e173478 commit 980ecc3

9 files changed

Lines changed: 147 additions & 124 deletions

NEWS.md

Lines changed: 121 additions & 121 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
OmicFlow is a generalised data structure for fast and efficient loading of various sparse omics data. It can handle metataxonomics/metagenomics data in text or [BIOM](https://biom-format.org/documentation/format_versions/biom-2.0.html) and extends to `proteomics` and other `omics` types. It also supports non-sparse data, but it's performance peaks in sparsity.
1212

1313
## Installation
14-
---
1514

1615
The latest stable version can be installed from CRAN.
1716

@@ -27,7 +26,7 @@ pak::pkg_install('agusinac/OmicFlow@dev')
2726
```
2827

2928
## Usage
30-
---
29+
3130
Initialize the `metagenomics` or any `omics` object from a filepath or pre-loaded object.
3231
```R
3332
library("OmicFlow")
@@ -61,7 +60,6 @@ str(taxa)
6160
```
6261

6362
### Visualisations
64-
---
6563

6664
#### 🔹Alpha diversity
6765
```R
@@ -76,6 +74,7 @@ alpha_div$plot
7674
![](man/figures/alphadiv_readme.png)
7775

7876
#### 🔹Beta diversity
77+
7978
By default PERMANOVA is applied pairwise against each group within the specified contrast, via `group_by` that is used in `pairwise_adonis`. The permutation design in `vegan::adonis2` is by default set to `free`. But this may not always be the right test when you have paired samples and you also want to restrict permutations between correlated values. Therefore, `pairwise_adonis` supports a custom permutation design, which can be constructed via [permute](https://cran.r-project.org/web/packages/permute/vignettes/permutations.html) and fed into `vegan::adonis2` as a function via `pairwise_adonis` with the flag `perm_design`.
8079
```R
8180
set.seed(1970)
@@ -132,6 +131,7 @@ patchwork::wrap_plots(
132131
![](man/figures/betadiv_readme.png)
133132

134133
#### 🔹Composition
134+
135135
```R
136136
res <- taxa$composition(
137137
feature_rank = "Genus",
@@ -167,4 +167,5 @@ docker run -it --rm -v \
167167
```
168168

169169
## Support
170+
170171
If you are having issues, please [create a ticket](https://github.com/agusinac/OmicFlow/issues)
14.3 KB
Loading

pkgdown/favicon/favicon-96x96.png

5.86 KB
Loading

pkgdown/favicon/favicon.ico

14.7 KB
Binary file not shown.

pkgdown/favicon/favicon.svg

Lines changed: 1 addition & 0 deletions
Loading

pkgdown/favicon/site.webmanifest

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"name": "",
3+
"short_name": "",
4+
"icons": [
5+
{
6+
"src": "/web-app-manifest-192x192.png",
7+
"sizes": "192x192",
8+
"type": "image/png",
9+
"purpose": "maskable"
10+
},
11+
{
12+
"src": "/web-app-manifest-512x512.png",
13+
"sizes": "512x512",
14+
"type": "image/png",
15+
"purpose": "maskable"
16+
}
17+
],
18+
"theme_color": "#ffffff",
19+
"background_color": "#ffffff",
20+
"display": "standalone"
21+
}
15.9 KB
Loading
74.5 KB
Loading

0 commit comments

Comments
 (0)