Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.1%) to scientific vocabulary
Last synced: 9 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: agusinac
  • License: other
  • Language: R
  • Default Branch: main
  • Size: 29.4 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 2
  • Releases: 2
Created almost 2 years ago · Last pushed 10 months ago
Metadata Files
Readme Changelog License Citation

README.md

CRAN Codecov R-CMD-check run with conda run with docker

OmicFlow

Installation


The latest stable version can be installed from CRAN.

r install.packages('OmicFlow', dependencies = TRUE)

The development version is available on GitHub.

r install.packages('pak') # if not yet installed pak::pak('agusinac/OmicFlow')

📋 Metadata File Specification

OmicFlow expects your sample metadata to follow a simple, but strict structure so that all datasets are compatible and validated up‑front. Sample metadata can be supplied as a CSV/TSV file or as a data.table in R. In both cases the sample metadata should contain a header (this is your first line if you supply a file) where each row = one sample Additional column names not mentioned here are allowed and will be ignored during the metadata validation step.


Minimum requirement

  • SAMPLE_ID ➡ every row must have a unique, non‑empty sample identifier.
  • No spaces are allowed in IDs — use underscores _ or dashes - instead.

Example:

| SAMPLEID | SAMPLEPAIRID | CONTRASTTreatment | VARIABLEAge | |-----------|---------------|--------------------|--------------| | S1 | P1 | Drug | 42 | | S2 | P1 | Placebo | 36 | | S3 | P2 | Drug | 51 |


Column types and naming rules

🔹 Required column

| Column | Type | Rules | |--------------|---------|------------------------------------------------------| | SAMPLE_ID | string | Unique, no spaces, one per sample row |

🔹 Optional standard columns

| Column | Type | Rules | |----------------|---------|---------------------------------------------------------------------| | FEATURE_ID | string | Optional — no spaces. Naming of the feature identifiers to include or exclude certain features | | SAMPLEPAIR_ID| string | Optional — no spaces. Use when samples are paired and belong to an individual source/subject |

🔹 Pattern‑based columns

You can define extra variables using special prefixes: - CONTRAST_... → grouping/category labels used in differential comparisons
Example: CONTRAST_Treatment with values Drug / Placebo - VARIABLE_... → numeric or string variables for statistical analysis
Example: VARIABLE_Age with values 42, 51, etc.

The pattern-based columns are only used during the autoFlow function. At the moment only columns with prefix CONTRAST_ are supported. Example: Outputs a report.html file in the current working directory ```R taxa$autoFlow( normalize = FALSE, weighted = TRUE, pvalue.threshold = 0.05 )

```

Usage

[!NOTE]

Make sure your metadata meets the requirements!

```R library("OmicFlow")

metadatafile <- system.file("extdata", "metadata.tsv", package = "OmicFlow") countsfile <- system.file("extdata", "counts.tsv", package = "OmicFlow") features_file <- system.file("extdata", "features.tsv", package = "OmicFlow")

taxa <- metagenomics$new( metaData = metadatafile, countData = countsfile, featureData = features_file )

taxa$feature_subset(Kingdom == "Bacteria") taxa$normalize()

```

Visualisations


[!NOTE] All visualizations use by default color-blind palettes!

🔹Alpha diversity

```R alphadiv <- taxa$alphadiversity( col_name = "treatment", metric = "shannon" )

alpha_div$plot ```

🔹Beta diversity

```R betadiv <- taxa$ordination( metric = "unifrac", method = "pcoa", groupby = "treatment" )

patchwork::wrapplots( betadiv[c("screeplot", "anovaplot", "scores_plot")], nrow = 1) ```

🔹Composition

```R res <- taxa$composition( featurerank = "Genus", featurefilter = c("uncultured"), featuretop = 15, normalize = FALSE, colname = "CONTRAST_sex" )

compositionplot( data = res$data, palette = res$palette, featurerank = "Genus", groupby = "CONTRASTsex" ) ```

🔹Volcano plot

```R res <- taxa$DFE( featurerank = "Genus", featurefilter = c("uncultured"), paired = FALSE, normalize = FALSE, condition.group = "CONTRASTsex", conditionA = "male", condition_B = "female" )

res$volcano_plot ```

Run autoflow via docker 🐳

For additional options please run autoflow -h ```bash docker pull agusinac/autoflow:1.3.0

docker run -it --rm -v \ "$(pwd)":/data \ # Mount the data in a temporary directory -w /data \ # set working directory -u $(id -u):$(id -g) \ # non-root user agusinac/autoflow:1.3.0 \ autoflow \ # autoflow R script -b /data/biomwithtaxonomy_hdf5.biom \ -m /data/metadata.tsv ```

Support

If you are having issues, please create a ticket

Owner

  • Name: Alem Gusinac
  • Login: agusinac
  • Kind: user

Citation (CITATION.md)

# Citations for Imported Packages

## ape

```
@Article{,
  title = {ape 5.0: an environment for modern phylogenetics and evolutionary analyses in {R}},
  author = {Emmanuel Paradis and Klaus Schliep},
  journal = {Bioinformatics},
  year = {2019},
  volume = {35},
  pages = {526-528},
  doi = {10.1093/bioinformatics/bty633},
}
```


## data.table

```
@Manual{,
  title = {data.table: Extension of `data.frame`},
  author = {Tyson Barrett and Matt Dowle and Arun Srinivasan and Jan Gorecki and Michael Chirico and Toby Hocking and Benjamin Schwendinger and Ivan Krylov},
  year = {2025},
  note = {R package version 1.17.0},
  url = {https://CRAN.R-project.org/package=data.table},
}
```


## gghalves

```
@Manual{,
  title = {gghalves: Compose Half-Half Plots Using Your Favourite Geoms},
  author = {Frederik Tiedemann},
  year = {2022},
  note = {R package version 0.1.4},
  url = {https://CRAN.R-project.org/package=gghalves},
}
```


## ggpubr

```
@Manual{,
  title = {ggpubr: 'ggplot2' Based Publication Ready Plots},
  author = {Alboukadel Kassambara},
  year = {2025},
  note = {R package version 0.6.1},
  url = {https://CRAN.R-project.org/package=ggpubr},
}
```


## ggrepel

```
@Manual{,
  title = {ggrepel: Automatically Position Non-Overlapping Text Labels with
'ggplot2'},
  author = {Kamil Slowikowski},
  year = {2024},
  note = {R package version 0.9.6},
  url = {https://CRAN.R-project.org/package=ggrepel},
}
```


## jsonlite

```
@Article{,
  title = {The jsonlite Package: A Practical and Consistent Mapping Between JSON Data and R Objects},
  author = {Jeroen Ooms},
  journal = {arXiv:1403.2805 [stat.CO]},
  year = {2014},
  url = {https://arxiv.org/abs/1403.2805},
}
```


## jsonvalidate

```
@Manual{,
  title = {jsonvalidate: Validate 'JSON' Schema},
  author = {Rich FitzJohn and Rob Ashton and Mathias Buus and Evgeny Poberezkin},
  year = {2025},
  note = {R package version 1.5.0},
  url = {https://CRAN.R-project.org/package=jsonvalidate},
}
```


## magrittr

```
@Manual{,
  title = {magrittr: A Forward-Pipe Operator for R},
  author = {Stefan Milton Bache and Hadley Wickham},
  year = {2022},
  note = {R package version 2.0.3},
  url = {https://CRAN.R-project.org/package=magrittr},
}
```


## Matrix

```
@Manual{,
  title = {Matrix: Sparse and Dense Matrix Classes and Methods},
  author = {Douglas Bates and Martin Maechler and Mikael Jagan},
  year = {2024},
  note = {R package version 1.6-5},
  url = {https://CRAN.R-project.org/package=Matrix},
}
```


## patchwork

```
@Manual{,
  title = {patchwork: The Composer of Plots},
  author = {Thomas Lin Pedersen},
  year = {2025},
  note = {R package version 1.3.1},
  url = {https://CRAN.R-project.org/package=patchwork},
}
```


## purrr

```
@Manual{,
  title = {purrr: Functional Programming Tools},
  author = {Hadley Wickham and Lionel Henry},
  year = {2025},
  note = {R package version 1.0.4},
  url = {https://CRAN.R-project.org/package=purrr},
}
```


## R6

```
@Manual{,
  title = {R6: Encapsulated Classes with Reference Semantics},
  author = {Winston Chang},
  year = {2025},
  note = {R package version 2.6.1},
  url = {https://CRAN.R-project.org/package=R6},
}
```


## rbiom

```
@Manual{,
  title = {rbiom: Read/Write, Analyze, and Visualize 'BIOM' Data},
  author = {Daniel P. Smith},
  year = {2025},
  note = {R package version 2.2.1},
  url = {https://CRAN.R-project.org/package=rbiom},
}
```


## RColorBrewer

```
@Manual{,
  title = {RColorBrewer: ColorBrewer Palettes},
  author = {Erich Neuwirth},
  year = {2022},
  note = {R package version 1.1-3},
  url = {https://CRAN.R-project.org/package=RColorBrewer},
}
```


## rhdf5

```
@Manual{,
  title = {rhdf5: R Interface to HDF5},
  author = {Bernd Fischer and Mike Smith and Gregoire Pau},
  year = {2023},
  note = {R package version 2.46.1},
  url = {https://bioconductor.org/packages/rhdf5},
  doi = {10.18129/B9.bioc.rhdf5},
}
```


## rmarkdown

```
@Manual{,
  title = {rmarkdown: Dynamic Documents for R},
  author = {JJ Allaire and Yihui Xie and Christophe Dervieux and Jonathan McPherson and Javier Luraschi and Kevin Ushey and Aron Atkins and Hadley Wickham and Joe Cheng and Winston Chang and Richard Iannone},
  year = {2024},
  note = {R package version 2.29},
  url = {https://github.com/rstudio/rmarkdown},
}

@Book{,
  title = {R Markdown: The Definitive Guide},
  author = {Yihui Xie and J.J. Allaire and Garrett Grolemund},
  publisher = {Chapman and Hall/CRC},
  address = {Boca Raton, Florida},
  year = {2018},
  isbn = {9781138359338},
  url = {https://bookdown.org/yihui/rmarkdown},
}

@Book{,
  title = {R Markdown Cookbook},
  author = {Yihui Xie and Christophe Dervieux and Emily Riederer},
  publisher = {Chapman and Hall/CRC},
  address = {Boca Raton, Florida},
  year = {2020},
  isbn = {9780367563837},
  url = {https://bookdown.org/yihui/rmarkdown-cookbook},
}
```


## rstatix

```
@Manual{,
  title = {rstatix: Pipe-Friendly Framework for Basic Statistical Tests},
  author = {Alboukadel Kassambara},
  year = {2023},
  note = {R package version 0.7.2},
  url = {https://CRAN.R-project.org/package=rstatix},
}
```


## slam

```
@Manual{,
  title = {slam: Sparse Lightweight Arrays and Matrices},
  author = {Kurt Hornik and David Meyer and Christian Buchta},
  year = {2024},
  note = {R package version 0.1-55},
  url = {https://CRAN.R-project.org/package=slam},
}
```


## stats

```
@Manual{,
  title = {R: A Language and Environment for Statistical Computing},
  author = {{R Core Team}},
  organization = {R Foundation for Statistical Computing},
  address = {Vienna, Austria},
  year = {2024},
  url = {https://www.R-project.org/},
}
```


## tools

```
@Manual{,
  title = {R: A Language and Environment for Statistical Computing},
  author = {{R Core Team}},
  organization = {R Foundation for Statistical Computing},
  address = {Vienna, Austria},
  year = {2024},
  url = {https://www.R-project.org/},
}
```


## utils

```
@Manual{,
  title = {R: A Language and Environment for Statistical Computing},
  author = {{R Core Team}},
  organization = {R Foundation for Statistical Computing},
  address = {Vienna, Austria},
  year = {2024},
  url = {https://www.R-project.org/},
}
```


## vegan

```
@Manual{,
  title = {vegan: Community Ecology Package},
  author = {Jari Oksanen and Gavin L. Simpson and F. Guillaume Blanchet and Roeland Kindt and Pierre Legendre and Peter R. Minchin and R.B. O'Hara and Peter Solymos and M. Henry H. Stevens and Eduard Szoecs and Helene Wagner and Matt Barbour and Michael Bedward and Ben Bolker and Daniel Borcard and Tuomas Borman and Gustavo Carvalho and Michael Chirico and Miquel {De Caceres} and Sebastien Durand and Heloisa Beatriz Antoniazi Evangelista and Rich FitzJohn and Michael Friendly and Brendan Furneaux and Geoffrey Hannigan and Mark O. Hill and Leo Lahti and Cameron Martino and Dan McGlinn and Marie-Helene Ouellette and Eduardo {Ribeiro Cunha} and Tyler Smith and Adrian Stier and Cajo J.F. {Ter Braak} and James Weedon},
  year = {2025},
  note = {R package version 2.7-1},
  url = {https://CRAN.R-project.org/package=vegan},
}
```


## viridis

```
@Manual{,
  title = {{viridis(Lite)} - Colorblind-Friendly Color Maps for R},
  author = {{Garnier} and {Simon} and {Ross} and {Noam} and {Rudis} and {Robert} and {Camargo} and Antônio Pedro and {Sciaini} and {Marco} and {Scherer} and {Cédric}},
  year = {2024},
  note = {viridis package version 0.6.5},
  url = {https://sjmgarnier.github.io/viridis/},
  doi = {10.5281/zenodo.4679423},
}
```


## yyjsonr

```
@Manual{,
  title = {yyjsonr: Fast 'JSON', 'NDJSON' and 'GeoJSON' Parser and Generator},
  author = {Mike Cheng and Yao Yuan},
  year = {2025},
  note = {R package version 0.1.21},
  url = {https://CRAN.R-project.org/package=yyjsonr},
}
```


## downloadthis

```
@Manual{,
  title = {downloadthis: Implement Download Buttons in 'rmarkdown'},
  author = {Felipe {Mattioni Maturana}},
  year = {2025},
  note = {R package version 0.5.0},
  url = {https://CRAN.R-project.org/package=downloadthis},
}
```


## DT

```
@Manual{,
  title = {DT: A Wrapper of the JavaScript Library 'DataTables'},
  author = {Yihui Xie and Joe Cheng and Xianying Tan},
  year = {2024},
  note = {R package version 0.33},
  url = {https://CRAN.R-project.org/package=DT},
}
```

GitHub Events

Total
  • Create event: 3
  • Release event: 3
  • Issues event: 4
  • Issue comment event: 1
  • Push event: 17
Last Year
  • Create event: 3
  • Release event: 3
  • Issues event: 4
  • Issue comment event: 1
  • Push event: 17

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 10
  • Total pull requests: 0
  • Average time to close issues: 22 days
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.6
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 10
  • Pull requests: 0
  • Average time to close issues: 22 days
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.6
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • agusinac (10)
Pull Request Authors
Top Labels
Issue Labels
enhancement (5) documentation (3)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 31 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
  • Total maintainers: 1
cran.r-project.org: OmicFlow

Fast and Efficient (Automated) Analysis of Sparse Omics Data

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 31 Last month
Rankings
Dependent packages count: 25.6%
Dependent repos count: 31.5%
Average: 47.5%
Downloads: 85.4%
Maintainers (1)
Last synced: 9 months ago

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • codecov/codecov-action v5 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • R >= 4.3.3 depends
  • Matrix * imports
  • R6 * imports
  • RColorBrewer * imports
  • ape * imports
  • cli * imports
  • data.table * imports
  • desc * imports
  • foreach * imports
  • gghalves * imports
  • ggpubr * imports
  • ggrepel * imports
  • grDevices * imports
  • jsonlite * imports
  • jsonvalidate * imports
  • magrittr * imports
  • optparse * imports
  • patchwork * imports
  • purrr * imports
  • rbiom * imports
  • rhdf5 * imports
  • rmarkdown * imports
  • rstatix * imports
  • slam * imports
  • stats * imports
  • tools * imports
  • utils * imports
  • vegan * imports
  • viridis * imports
  • yyjsonr * imports
  • ggplot2 * suggests
  • testthat >= 3.0.0 suggests