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%",
  message = FALSE,
  warning = FALSE
)
```

# RandomWalker <img src="man/figures/logo.png" width="147" height="170" align="right" />

<!-- badges: start -->
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/RandomWalker)](https://cran.r-project.org/package=RandomWalker)
![](https://cranlogs.r-pkg.org/badges/RandomWalker)
![](https://cranlogs.r-pkg.org/badges/grand-total/RandomWalker)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html##experimental)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
<!-- badges: end -->

The goal of RandomWalker is to allow users to easily create Random Walks of different
types that are compatible with the `tidyverse` suite of packages. The package is
currently in the experimental stage of development.

## Installation

You can install the released version of {TidyDensity} from CRAN with:

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

You can install the development version of RandomWalker from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("spsanderson/RandomWalker")
```

## Example

This is a basic example which shows you how to solve a common problem:

```{r rw30_example}
library(RandomWalker)
## basic example code
rw30() |>
  head(10)
```

Here is a basic visualization of a Random Walk:

```{r random_walk_visual_example}
#| fig.alt: >
#|   Visualize a Random Walk of 30 simulations
rw30() |>
  visualize_walks()
```

Here is a basic summary of the random walks:

```{r random_walk_summary}
rw30() |>
  summarize_walks(.value = y)

rw30() |>
  summarize_walks(.value = y, .group_var = walk_number)
```