README.Rmd

---
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%"
)
```

# Momoshop <a href="https://momx.github.io/Momoshop/"><img src="man/figures/logo.png" align="right" height="139" alt="Momoshop website" /></a>

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/Momoshop)](https://CRAN.R-project.org/package=Momoshop)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![R-CMD-check](https://github.com/MomX/Momoshop/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/MomX/Momoshop/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The goal of Momoshop is to provide a convenient way to handle processing of images after acquisition and before morphometrics

It uses [shiny](https://shiny.posit.co/) to wrap most useful [magick](https://github.com/ropensci/magick) functions for that purpose.

## Installation

Once released on CRAN, you can install the development version of Momoshop like so:

``` r
install.packages("Momoshop")
```

Momoshop is part of [MomX](https://momx.github.io/) a very young and still experimental ecosystem. During its development and also before CRAN releases, you may better get the development version instead:

``` r
pak::pkg_install("MomX/Momoshop")
``` 

## How to use it

Launch the app on your images and usage should be self-explanatory. Momoshop also has a manual inside the app. 

```{r example}
library(Momoshop)
## basic example code
```

The app returns a magick 'pipe' that you can use outside the app to post-process
```{r}
library(magick)
```