update documentation

LICENSE

@@ -1,2 +1,2 @@
-YEAR: 2023
+YEAR: 2024
 COPYRIGHT HOLDER: Jan Broder Engler

LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2023 Jan Broder Engler
+Copyright (c) 2024 Jan Broder Engler
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.Rmd

@@ -35,7 +35,7 @@ pak::pak("jbengler/tidyplots")
 
 ## Usage
 
-Here are some examples of what you can do with 3--5 lines of code.
+Here are some examples of what you can do with just a few key strokes. The full documentation can be found [here](https://jbengler.github.io/tidyplots/).
 
 ```{r}
 library(tidyplots)
@@ -71,6 +71,13 @@ energy_week %>%
 
 ```
 
+```{r}
+energy_week %>% 
+  tidyplot(date, power, color = energy_source) %>% 
+  add_areastack_relative()
+
+```
+
 ```{r}
 study %>% 
   tidyplot(x = group, y = score, color = dose) %>% 
@@ -97,6 +104,38 @@ study %>%
 
 ```
 
-## Documentation
+```{r, fig.height=3.2}
+gene_expression %>% 
+  dplyr::filter(external_gene_name %in% c("Apol6", "Col5a3", "Vgf", "Bsn")) %>% 
+  tidyplot(x = condition, y = expression, color = sample_type) %>% 
+  add_mean_dash() %>% 
+  add_error() %>% 
+  add_jitter() %>% 
+  add_stats_pvalue(include_info = FALSE) %>% 
+  adjust_x_axis(title = "") %>% 
+  split_plot(by = external_gene_name)
+
+```
+
+
+## Acknowledgements
+
+tidyplots relies on a number of fantastic packages that do all the heavy lifting behind the scenes. These include 
+    cli,
+    dplyr,
+    forcats,
+    ggplot2,
+    ggpubr,
+    ggrastr,
+    ggrepel,
+    glue,
+    Hmisc,
+    patchwork,
+    purrr,
+    ragg,
+    rlang,
+    scales,
+    stringr,
+    svglite and
+    tidyr.
 
-https://jbengler.github.io/tidyplots/

README.md

@@ -21,7 +21,9 @@ pak::pak("jbengler/tidyplots")
 
 ## Usage
 
-Here are some examples of what you can do with 3–5 lines of code.
+Here are some examples of what you can do with just a few key strokes.
+The full documentation can be found
+[here](https://jbengler.github.io/tidyplots/).
 
 ``` r
 library(tidyplots)
@@ -61,6 +63,14 @@ energy_week %>%
 
 <img src="man/figures/README-unnamed-chunk-5-1.png" style="display: block; margin: auto;" />
 
+``` r
+energy_week %>% 
+  tidyplot(date, power, color = energy_source) %>% 
+  add_areastack_relative()
+```
+
+<img src="man/figures/README-unnamed-chunk-6-1.png" style="display: block; margin: auto;" />
+
 ``` r
 study %>% 
   tidyplot(x = group, y = score, color = dose) %>% 
@@ -69,7 +79,7 @@ study %>%
   add_mean_value()
 ```
 
-<img src="man/figures/README-unnamed-chunk-6-1.png" style="display: block; margin: auto;" />
+<img src="man/figures/README-unnamed-chunk-7-1.png" style="display: block; margin: auto;" />
 
 ``` r
 time_course %>%
@@ -79,7 +89,7 @@ time_course %>%
   add_error_ribbon()
 ```
 
-<img src="man/figures/README-unnamed-chunk-7-1.png" style="display: block; margin: auto;" />
+<img src="man/figures/README-unnamed-chunk-8-1.png" style="display: block; margin: auto;" />
 
 ``` r
 study %>% 
@@ -88,8 +98,25 @@ study %>%
   add_stats_pvalue(ref.group = 1)
 ```
 
-<img src="man/figures/README-unnamed-chunk-8-1.png" style="display: block; margin: auto;" />
+<img src="man/figures/README-unnamed-chunk-9-1.png" style="display: block; margin: auto;" />
+
+``` r
+gene_expression %>% 
+  dplyr::filter(external_gene_name %in% c("Apol6", "Col5a3", "Vgf", "Bsn")) %>% 
+  tidyplot(x = condition, y = expression, color = sample_type) %>% 
+  add_mean_dash() %>% 
+  add_error() %>% 
+  add_jitter() %>% 
+  add_stats_pvalue(include_info = FALSE) %>% 
+  adjust_x_axis(title = "") %>% 
+  split_plot(by = external_gene_name)
+```
+
+<img src="man/figures/README-unnamed-chunk-10-1.png" style="display: block; margin: auto;" />
 
-## Documentation
+## Acknowledgements
 
-<https://jbengler.github.io/tidyplots/>
+tidyplots relies on a number of fantastic packages that do all the heavy
+lifting behind the scenes. These include cli, dplyr, forcats, ggplot2,
+ggpubr, ggrastr, ggrepel, glue, Hmisc, patchwork, purrr, ragg, rlang,
+scales, stringr, svglite and tidyr.

_pkgdown.yml

@@ -2,6 +2,10 @@ url: https://jbengler.github.io/tidyplots/
 template:
   bootstrap: 5
 
+authors:
+  Jan Broder Engler:
+    href: https://github.com/jbengler
+
 reference:
 - title:
   desc: >