diff --git a/R/auto-rw30.R b/R/auto-rw30.R index 937298a..638b2ca 100644 --- a/R/auto-rw30.R +++ b/R/auto-rw30.R @@ -18,9 +18,23 @@ #' `num_steps`, `mu`, and `sd` are attached to the tibble. #' #' @examples +#' library(ggplot2) +#' #' # Generate random walks and print the result #' rw30() #' +#' rw30() |> +#' ggplot(aes(x = x, y = y, color = walk_number, group = walk_number)) + +#' geom_line() + +#' theme_minimal() + +#' theme(legend.position = "none") + +#' labs( +#' title = "30 Random Walks", +#' x = "Step", +#' y = "Value", +#' color = "Walk Number" +#' ) +#' #' @name rw30 NULL #' @rdname rw30 diff --git a/R/gen-brown-motion.R b/R/gen-brown-motion.R index 4c84df0..2562250 100644 --- a/R/gen-brown-motion.R +++ b/R/gen-brown-motion.R @@ -32,8 +32,17 @@ #' of class matrix will be returned. #' #' @examples +#' library(ggplot2) +#' #' brownian_motion() #' +#' brownian_motion() |> +#' ggplot(aes(x = x, y = y, group = walk_number, color = walk_number)) + +#' geom_line() + +#' labs(title = "Brownian Motion", x = "Time", y = "Value") + +#' theme_minimal() + +#' theme(legend.position = "none") +#' #' @return #' A tibble/matrix #' diff --git a/R/gen-geom-brown-motion.R b/R/gen-geom-brown-motion.R index 0fd5036..5fa6be8 100644 --- a/R/gen-geom-brown-motion.R +++ b/R/gen-geom-brown-motion.R @@ -43,8 +43,17 @@ #' of class matrix will be returned. #' #' @examples +#' library(ggplot2) +#' #' geometric_brownian_motion() #' +#' geometric_brownian_motion() |> +#' ggplot(aes(x = x, y = y, group = walk_number, color = walk_number)) + +#' geom_line() + +#' labs(title = "Geometric Brownian Motion", x = "Time", y = "Value") + +#' theme_minimal() + +#' theme(legend.position = "none") +#' #' @return #' A tibble/matrix #' diff --git a/R/gen-random-drift-walk.R b/R/gen-random-drift-walk.R index 9e99bba..d9866bb 100644 --- a/R/gen-random-drift-walk.R +++ b/R/gen-random-drift-walk.R @@ -27,7 +27,7 @@ #' #' walks <- random_normal_drift_walk(.num_walks = 10, .n = 50, .mu = 0, .sd = 1, #' .drift = 0.05) -#' ggplot(walks, ggplot2::aes(x = x, y = y, group = walk_number, color = walk_number)) + +#' ggplot(walks, aes(x = x, y = y, group = walk_number, color = walk_number)) + #' geom_line() + #' labs(title = "Random Walks with Drift", x = "Time", y = "Value") + #' theme_minimal() + diff --git a/R/gen-random-normal-walk.R b/R/gen-random-normal-walk.R index 82e0866..a5029fa 100644 --- a/R/gen-random-normal-walk.R +++ b/R/gen-random-normal-walk.R @@ -48,6 +48,13 @@ #' # Generate random walks with different mean and standard deviation #' random_normal_walk(.num_walks = 10, .n = 50, .samp = FALSE) #' +#' random_normal_walk(.num_walks = 2, .n = 100) |> +#' ggplot(aes(x = x, y = y, group = walk_number, color = walk_number)) + +#' geom_line() + +#' labs(title = "Random Normal Walk", x = "Time", y = "Value") + +#' theme_minimal() + +#' theme(legend.position = "none") +#' #' @name random_normal_walk NULL #' @rdname random_normal_walk diff --git a/docs/404.html b/docs/404.html index 4ad42ab..3322262 100644 --- a/docs/404.html +++ b/docs/404.html @@ -6,11 +6,18 @@ Page not found (404) • RandomWalker + + + + + + + Skip to contents @@ -47,8 +54,7 @@
- -

Page not found (404)

+

Page not found (404)

diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index 7e34aed..939fe45 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -1,5 +1,5 @@ -License • RandomWalker +License • RandomWalker Skip to contents @@ -29,8 +29,7 @@
- -

License

+

License

diff --git a/docs/LICENSE.html b/docs/LICENSE.html index 67a5a70..eea5c43 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -1,5 +1,5 @@ -MIT License • RandomWalker +MIT License • RandomWalker Skip to contents @@ -29,8 +29,7 @@
- -

MIT License

+

MIT License

Source: LICENSE.md
diff --git a/docs/apple-touch-icon-120x120.png b/docs/apple-touch-icon-120x120.png new file mode 100644 index 0000000..c56db63 Binary files /dev/null and b/docs/apple-touch-icon-120x120.png differ diff --git a/docs/apple-touch-icon-152x152.png b/docs/apple-touch-icon-152x152.png new file mode 100644 index 0000000..f51704c Binary files /dev/null and b/docs/apple-touch-icon-152x152.png differ diff --git a/docs/apple-touch-icon-180x180.png b/docs/apple-touch-icon-180x180.png new file mode 100644 index 0000000..f9846ac Binary files /dev/null and b/docs/apple-touch-icon-180x180.png differ diff --git a/docs/apple-touch-icon-60x60.png b/docs/apple-touch-icon-60x60.png new file mode 100644 index 0000000..90c7d6e Binary files /dev/null and b/docs/apple-touch-icon-60x60.png differ diff --git a/docs/apple-touch-icon-76x76.png b/docs/apple-touch-icon-76x76.png new file mode 100644 index 0000000..e477e60 Binary files /dev/null and b/docs/apple-touch-icon-76x76.png differ diff --git a/docs/apple-touch-icon.png b/docs/apple-touch-icon.png new file mode 100644 index 0000000..b4bec7f Binary files /dev/null and b/docs/apple-touch-icon.png differ diff --git a/docs/articles/getting-started.html b/docs/articles/getting-started.html index 31dcd75..afc6461 100644 --- a/docs/articles/getting-started.html +++ b/docs/articles/getting-started.html @@ -6,6 +6,12 @@ Getting Started with RandomWalker • RandomWalker + + + + + + @@ -51,8 +57,7 @@
- -

Getting Started with RandomWalker

+

Getting Started with RandomWalker

Source: vignettes/getting-started.Rmd diff --git a/docs/articles/index.html b/docs/articles/index.html index 8116244..ec2a3cb 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -1,5 +1,5 @@ -Articles • RandomWalker +Articles • RandomWalker Skip to contents @@ -29,8 +29,7 @@
- -

Articles

+

Articles

diff --git a/docs/authors.html b/docs/authors.html index 73af6d3..d989bba 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -1,5 +1,5 @@ -Authors and Citation • RandomWalker +Authors and Citation • RandomWalker Skip to contents @@ -29,8 +29,7 @@
- -

Authors and Citation

+

Authors and Citation

diff --git a/docs/favicon-16x16.png b/docs/favicon-16x16.png new file mode 100644 index 0000000..6f2d8f1 Binary files /dev/null and b/docs/favicon-16x16.png differ diff --git a/docs/favicon-32x32.png b/docs/favicon-32x32.png new file mode 100644 index 0000000..9ba5e43 Binary files /dev/null and b/docs/favicon-32x32.png differ diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000..ac48d23 Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/index.html b/docs/index.html index 88ead1a..58cb489 100644 --- a/docs/index.html +++ b/docs/index.html @@ -6,6 +6,12 @@ Generate Random Walks Compatible With The tidyverse • RandomWalker + + + + + + @@ -13,6 +19,7 @@ + Skip to contents @@ -49,8 +56,10 @@
-

RandomWalker -

+
+

RandomWalker +

+

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.

@@ -70,16 +79,20 @@

Examplelibrary(RandomWalker) ## basic example code rw30() |> - head() -#> # A tibble: 6 × 3 -#> walk_number x y -#> <fct> <int> <dbl> -#> 1 1 1 0 -#> 2 1 2 -0.859 -#> 3 1 3 -2.52 -#> 4 1 4 -2.88 -#> 5 1 5 -2.74 -#> 6 1 6 -3.90

+ head(10) +#> # A tibble: 10 × 3 +#> walk_number x y +#> <fct> <int> <dbl> +#> 1 1 1 0 +#> 2 1 2 -0.821 +#> 3 1 3 -0.969 +#> 4 1 4 -2.08 +#> 5 1 5 -3.58 +#> 6 1 6 -2.50 +#> 7 1 7 -4.65 +#> 8 1 8 -4.68 +#> 9 1 9 -5.75 +#> 10 1 10 -6.49