Merge pull request #11 from spsanderson/development

update site
spsanderson · Jul 13, 2024 · bc2e94a · bc2e94a
2 parents 87ca0f8 + 4f4b99d
commit bc2e94a
Show file tree

Hide file tree

Showing 17 changed files with 213 additions and 80 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -16,9 +16,16 @@ knitr::opts_chunk$set(
 # RandomWalker
 
 <!-- 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 ...
+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
 
@@ -36,20 +43,5 @@ This is a basic example which shows you how to solve a common problem:
 ```{r example}
 library(RandomWalker)
 ## basic example code
+rw30()
 ```
-
-What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:
-
-```{r cars}
-summary(cars)
-```
-
-You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this.
-
-You can also embed plots, for example:
-
-```{r pressure, echo = FALSE}
-plot(pressure)
-```
-
-In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.
diff --git a/README.md b/README.md
@@ -4,9 +4,20 @@
 # RandomWalker
 
 <!-- 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 …
+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
 
@@ -25,28 +36,19 @@ This is a basic example which shows you how to solve a common problem:
 ``` r
 library(RandomWalker)
 ## basic example code
+rw30()
+#> # A tibble: 3,000 × 3
+#>    walk       x value
+#>    <fct>  <int> <dbl>
+#>  1 walk_1     1 0    
+#>  2 walk_1     2 0.916
+#>  3 walk_1     3 1.26 
+#>  4 walk_1     4 1.84 
+#>  5 walk_1     5 2.53 
+#>  6 walk_1     6 1.39 
+#>  7 walk_1     7 1.94 
+#>  8 walk_1     8 2.42 
+#>  9 walk_1     9 1.86 
+#> 10 walk_1    10 2.27 
+#> # ℹ 2,990 more rows
 ```
-
-What is special about using `README.Rmd` instead of just `README.md`?
-You can include R chunks like so:
-
-``` r
-summary(cars)
-#>      speed           dist       
-#>  Min.   : 4.0   Min.   :  2.00  
-#>  1st Qu.:12.0   1st Qu.: 26.00  
-#>  Median :15.0   Median : 36.00  
-#>  Mean   :15.4   Mean   : 42.98  
-#>  3rd Qu.:19.0   3rd Qu.: 56.00  
-#>  Max.   :25.0   Max.   :120.00
-```
-
-You’ll still need to render `README.Rmd` regularly, to keep `README.md`
-up-to-date. `devtools::build_readme()` is handy for this.
-
-You can also embed plots, for example:
-
-<img src="man/figures/README-pressure-1.png" width="100%" />
-
-In that case, don’t forget to commit and push the resulting figure
-files, so they display on GitHub and CRAN.
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -10,12 +10,18 @@ navbar:
   left:
     - icon: "fa-home"
       href: index.html
-      aria-lable: "Home"
+      aria-label: Home
     - text: "Getting Started"
       href: articles/getting-started.html
     - text: "Function Reference"
       href: reference/index.html
     - text: "News"
       href: news/index.html
 
+reference:
+  -  title: Automatic Random Wallks
+     desc: Functions that generate non-modifiable random walks
+     contents:
+     -  has_concept("Auto Random Walk")
+
 search:
diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/LICENSE.html b/docs/LICENSE.html
diff --git a/docs/articles/getting-started.html b/docs/articles/getting-started.html
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -3,7 +3,7 @@ pkgdown: 2.1.0
 pkgdown_sha: ~
 articles:
   getting-started: getting-started.html
-last_built: 2024-07-12T13:31Z
+last_built: 2024-07-13T12:55Z
 urls:
   reference: https://www.spsanderson.com/RandomWalker/reference
   article: https://www.spsanderson.com/RandomWalker/articles
diff --git a/docs/reference/Rplot001.png b/docs/reference/Rplot001.png