Skip to content

Latest commit

 

History

History
131 lines (98 loc) · 5.44 KB

File metadata and controls

131 lines (98 loc) · 5.44 KB

RandomWalker Wiki

Welcome to the RandomWalker Wiki! This comprehensive guide will help you master the RandomWalker R package for generating, visualizing, and analyzing random walks.

📖 What is RandomWalker?

RandomWalker is a comprehensive R package that provides a unified, tidyverse-compatible interface for generating random walks of various types. Whether you're modeling stock prices, simulating particle movements, or exploring stochastic processes, RandomWalker makes it easy to:

  • Generate random walks from 27+ different probability distributions
  • Create walks in 1D, 2D, or 3D space
  • Visualize walks with beautiful, interactive plots
  • Compute comprehensive statistical summaries
  • Work seamlessly with tidyverse tools

🚀 Quick Navigation

Getting Started

Function Guides

Advanced Topics

Reference

Contributing

💡 Key Features

🎲 27+ Distribution Types

Generate random walks from a wide variety of probability distributions including:

  • Continuous: Normal, Brownian Motion, Geometric Brownian Motion, Beta, Cauchy, Chi-Squared, Exponential, F, Gamma, Log-Normal, Logistic, Student's t, Uniform, Weibull
  • Discrete: Binomial, Discrete, Geometric, Hypergeometric, Multinomial, Negative Binomial, Poisson
  • Custom: Define your own displacement functions

📐 Multi-Dimensional Support

  • 1D random walks for time series analysis
  • 2D random walks for spatial modeling
  • 3D random walks for particle physics simulations

📊 Rich Visualizations

  • Static plots with ggplot2
  • Interactive visualizations with ggiraph
  • Support for multiple walk comparison
  • Customizable aesthetics

📈 Statistical Analysis

  • Comprehensive summary statistics
  • Cumulative functions (sum, product, min, max, mean)
  • Confidence intervals
  • Running quantiles
  • Euclidean distance calculations
  • Harmonic and geometric means
  • Skewness and kurtosis

🔧 Tidyverse Compatible

Works seamlessly with:

  • dplyr for data manipulation
  • tidyr for data reshaping
  • ggplot2 for custom visualizations
  • Pipe operators (|> and %>%)

📦 Package Information

  • Current Version: 1.0.0.9000 (development)
  • CRAN Release: 1.0.0
  • License: MIT
  • Authors: Steven P. Sanderson II, MPH & Antti Rask
  • R Version Required: >= 4.1.0

🔗 External Links

📚 Learning Path

If you're new to RandomWalker, we recommend following this learning path:

  1. Installation - Install the package
  2. Quick Start Guide - Learn the basics
  3. Automatic Random Walks - Use rw30() for quick results
  4. Continuous Distribution Generators - Explore different distributions
  5. Visualization Guide - Create beautiful plots
  6. Statistical Analysis Guide - Analyze your walks
  7. Use Cases and Examples - See real-world applications

🎯 Common Use Cases

  • Finance: Model stock price movements with Geometric Brownian Motion
  • Physics: Simulate particle diffusion with Brownian Motion
  • Biology: Model organism movement patterns
  • Computer Science: Generate test data for algorithms
  • Education: Teach probability and stochastic processes
  • Research: Explore theoretical properties of random walks

🤝 Getting Help

🌟 Citation

If you use RandomWalker in your research, please cite it:

citation("RandomWalker")

Ready to get started? Head over to the Installation page to begin your journey with RandomWalker!