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%"
)
options(tibble.print_min = 5, tibble.print_max = 5)
```

# mpathr <img src="man/figures/logo.png" align="right" height="120" alt="" />

<!-- badges: start -->
[![R-CMD-check](https://github.com/m-path-io/mpathr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/m-path-io/mpathr/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/m-path-io/mpathr/graph/badge.svg)](https://app.codecov.io/gh/m-path-io/mpathr)
[![CRAN status](https://www.r-pkg.org/badges/version/mpathr)](https://CRAN.R-project.org/package=mpathr)
<!-- badges: end -->

## Overview

The goal of `mpathr` is to provide with a few utility functions to read and perform some common operations in data from Experience Sampling Methodology (ESM) studies collected through the m-Path platform (<https://m-path.io/landing/>). The package provides functions to read data from m-Path, and to calculate response rate in data from Experience Sampling studies. 

An overview of how to use this package (as well as a video and a detailed guide) can be found in the [m-Path manual](https://m-path.io/manual/knowledge-base/importing-and-analyzing-m-path-data-in-r-mpathr/).

## Installation

```{r installation, eval = FALSE}
install.packages("mpathr")
library(mpathr)
```

```{r loading, include = FALSE}
library(mpathr)
```

## Example

This is a basic example which shows you how to read data gathered from m-Path
into R using the `mpathr` package. For this, we use the example data included 
in the package:

```{r example}
# loads package
library(mpathr)

# find paths to example basic and meta data:
basic_path <- mpath_example(file ='example_basic.csv')
meta_path <- mpath_example(file = 'example_meta.csv')

# read the data
data <- read_mpath(
  file = basic_path,
  meta_data = meta_path
)

print(data)
```

## Getting help
If you encounter a clear bug or need help getting a function to run, please file an issue with a minimal reproducible example on [Github](https://github.com/m-path-io/mpathr/issues).

## Code of Conduct
Please note that the mpathr project is released with a
[Contributor Code of Conduct](https://github.com/m-path-io/mpathr/blob/master/CODE_OF_CONDUCT.md). By contributing to this project you agree to abide by its terms.