From 4f4b99d73d8732ad4210cd46ca78784d4fb7e20f Mon Sep 17 00:00:00 2001 From: "Steven Paul Sanderson II, MPH" Date: Sat, 13 Jul 2024 08:57:17 -0400 Subject: [PATCH] update site --- README.Rmd | 26 +++---- README.md | 52 +++++++------- _pkgdown.yml | 8 ++- docs/404.html | 2 +- docs/LICENSE-text.html | 2 +- docs/LICENSE.html | 2 +- docs/articles/getting-started.html | 4 +- docs/articles/index.html | 2 +- docs/authors.html | 6 +- docs/index.html | 52 ++++++++------ docs/news/index.html | 2 +- docs/pkgdown.yml | 2 +- docs/reference/Rplot001.png | Bin 0 -> 1011 bytes docs/reference/index.html | 23 ++++++- docs/reference/rw30.html | 107 +++++++++++++++++++++++++++++ docs/search.json | 2 +- docs/sitemap.xml | 1 + 17 files changed, 213 insertions(+), 80 deletions(-) create mode 100644 docs/reference/Rplot001.png create mode 100644 docs/reference/rw30.html diff --git a/README.Rmd b/README.Rmd index 5751baf..b497ad9 100644 --- a/README.Rmd +++ b/README.Rmd @@ -16,9 +16,16 @@ knitr::opts_chunk$set( # RandomWalker +[![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) -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 index dbc4673..3352595 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,20 @@ # RandomWalker + +[![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) -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 +#> +#> 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: - - - -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 index c18894a..c8f7b09 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -10,7 +10,7 @@ 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" @@ -18,4 +18,10 @@ navbar: - 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 index aadc960..4ad42ab 100644 --- a/docs/404.html +++ b/docs/404.html @@ -29,7 +29,7 @@ - +
+

Dev status

+
    +
  • CRAN_Status_Badge
    • +
  • Lifecycle: experimental
    • +
  • PRs Welcome
    • +
+
diff --git a/docs/news/index.html b/docs/news/index.html index 0e6fc82..f12f254 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -15,7 +15,7 @@