In SchlossLab/mikRopML: User-Friendly R Package for Supervised Machine Learning Pipelines

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

mikropml

meek-ROPE em el

User-Friendly R Package for Supervised Machine Learning Pipelines

An interface to build machine learning models for classification and regression problems. mikropml implements the ML pipeline described by Topçuoğlu et al. (2020) with reasonable default options for data preprocessing, hyperparameter tuning, cross-validation, testing, model evaluation, and interpretation steps. See the website for more information, documentation, and examples.

Installation

You can install the latest release from CRAN:

install.packages('mikropml')

or the development version from GitHub:

# install.packages("devtools")
devtools::install_github("SchlossLab/mikropml")

or install from a terminal using conda or mamba:

```{bash conda, eval = FALSE} mamba install -c conda-forge r-mikropml

### Dependencies

```r
library(dplyr)
description <- utils::packageDescription('mikropml', 
                                         fields = c('Imports', 'Suggests'))
deps <- lapply(names(description), 
               function (x) {
                 paste0('- ', x, ': ', 
                        description[[x]] %>% 
                          gsub("\n", " ", .))}
               ) %>% 
  unlist() %>% 
  paste(., collapse = '\n')

r deps

Usage

Check out the introductory vignette for a quick start tutorial. For a more in-depth discussion, read all the vignettes and/or take a look at the reference documentation.

You can watch the Riffomonas Project series of video tutorials covering mikropml and other skills related to machine learning.

We also provide a Snakemake workflow for running mikropml locally or on an HPC. We highly recommend running mikropml with Snakemake or another workflow management system for reproducibility and scalability of ML analyses.

Help & Contributing

If you come across a bug, open an issue and include a minimal reproducible example.

If you have questions, create a new post in Discussions.

If you'd like to contribute, see our guidelines here.

Code of Conduct

Please note that the mikropml project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

The mikropml package is licensed under the MIT license. Text and images included in this repository, including the mikropml logo, are licensed under the CC BY 4.0 license.

Citation

To cite mikropml in publications, use:

r cat(format(citation('mikropml'), style = 'html'))

A BibTeX entry for LaTeX users is:

cat("```\n", format(citation('mikropml'), style = 'bibtex'), "\n```")

Why the name?

The word "mikrop" (pronounced "meek-ROPE") is Turkish for "microbe". This package was originally implemented as a machine learning pipeline for microbiome-based classification problems (see Topçuoğlu et al. 2020). We realized that these methods are applicable in many other fields too, but stuck with the name because we like it!

SchlossLab/mikRopML documentation built on Aug. 26, 2023, 5:58 a.m.