inst/doc/api-reference.R

In RandomWalker: Generate Random Walks Compatible with the 'tidyverse'

## ----include = FALSE----------------------------------------------------------
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)

## ----setup, echo=FALSE, message=FALSE-----------------------------------------
library(RandomWalker)

## ----rw30_example-------------------------------------------------------------
# Generate and view
rw30() |> head(10)

## ----rw30_visualize, fig.width=7, fig.height=4--------------------------------
# Visualize
rw30() |> visualize_walks()

## ----rw30_analyze-------------------------------------------------------------
# Analyze
rw30() |> summarize_walks(.value = y) |> head()

## ----normal_walk--------------------------------------------------------------
random_normal_walk(.num_walks = 10, .mu = 0, .sd = 1) |> head()

## ----visualize_basic, fig.width=7, fig.height=4-------------------------------
# Basic visualization
rw30() |> visualize_walks()

## ----visualize_alpha, fig.width=7, fig.height=4-------------------------------
# Adjust transparency
rw30() |> visualize_walks(.alpha = 0.3)

## ----summarize_walks----------------------------------------------------------
walks <- rw30()

# Overall summary
walks |> summarize_walks(.value = y) |> head()

## ----summarize_by_walk--------------------------------------------------------
# By walk
walks |> 
  summarize_walks(.value = y, .group_var = walk_number) |> 
  head()

## ----summarize_cumsum---------------------------------------------------------
# Cumulative sum
walks |>
  dplyr::mutate(cum_sum = cumsum(y)) |>
  summarize_walks(.value = cum_sum) |>
  head()

## ----get_attributes-----------------------------------------------------------
walks <- rw30()
get_attributes(walks)

## ----attributes_example-------------------------------------------------------
walks <- random_normal_walk(.num_walks = 10, .n = 100)
atb <- attributes(walks)
atb[!names(atb) %in% c("row.names")]