update readme and logo

R/todo.R

@@ -1,22 +1,26 @@
 
-# When bug in cut_short_scale() is fixed (expected in scales 1.3.1), change default: adjust_y_axis(cut_short_scale = TRUE)
-
 # work on check_pipeline()
 # enforce "sequence of funs", with warnings and errors
+# tidyplot, add, adjust, split
+# (render, save, theme, remove) can always be used
 
 # what happens when tidyplot functions are applied to a ggplot that is was NOT generated with tidyplot()
+# include internal function check_tidyplot(gg) -> Error: no tidyplot, use tidyplot() function
 
 # make color schemes accessible
 
-# make hex sticker
+
+## FOR LATER:
+## ------------------------------------------------
+
+# When bug in cut_short_scale() is fixed (expected in scales 1.3.1), change default: adjust_y_axis(cut_short_scale = TRUE)
+
+# allow options, e.g. with something like tp_options <- list()
 
 # rename adjust_labels() to adjust_variable() ? Not sure.
 
 # add easteregg: add_funkyness()
 
-## BEYOND SCOPE:
-## ------------------------------------------------
-
 # text_labels for pie, donut and barstack? It is complicated!
 # https://r-charts.com/part-whole/pie-chart-labels-outside-ggplot2/
 

README.Rmd

@@ -19,30 +19,37 @@ knitr::opts_chunk$set(
 )
 ```
 
-# tidyplots
+# tidyplots <a href="https://jbengler.github.io/tidyplots/"><img src="man/figures/logo.svg" align="right" height="139" alt="tidyplots website" /></a>
 
 <!-- badges: start -->
-[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
 <!-- badges: end -->
 
-## Overview
-
-tidyplots is an opinionated plotting package that makes to it ridiculously simple to create ready-to-use plots for scientific papers. It works by gradually adding and adjusting plot components and provides full control over composition, style, and absolute sizes. tidyplots is powered by the pipe `%>%` and provides a clean and minimalist interface for commonly used scientific plotting routines.
+tidyplots streamlines the creation of publication-ready plots for scientific papers, making it incredibly easy to incorporate and refine plot elements. It allows precise control over composition, style, and absolute sizes, while its utilization of the pipe `%>%` simplifies the construction of powerful plotting pipelines.
 
 ## Installation
 
-You can install the development version of `tidyplots` from [GitHub](https://github.com/) with:
-
 ``` r
-# install.packages("devtools")
-devtools::install_github("jbengler/tidyplots")
+# install.packages("pak")
+pak::pak("jbengler/tidyplots")
 ```
 
-## Example
+## Usage
+
+This is a basic example which shows you how to create a simple plot.
 
-This is a basic example which shows you how to solve a common problem:
+```{r, eval=FALSE}
+library(tidyplots)
+
+study %>% 
+  tidyplot(x = treatment, y = score, color = treatment) %>% 
+  add_mean_bar(alpha = 0.3) %>% 
+  add_error() %>% 
+  add_jitter() %>% 
+  save_plot("my_plot.pdf")
+
+```
 
-```{r example}
+```{r, echo=FALSE}
 library(tidyplots)
 
 study %>% 
@@ -53,6 +60,6 @@ study %>%
 
 ```
 
-## Learn more
+## Documentation
 
 https://jbengler.github.io/tidyplots/

README.md

@@ -1,36 +1,27 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# tidyplots
+# tidyplots <a href="https://jbengler.github.io/tidyplots/"><img src="man/figures/logo.svg" align="right" height="139" alt="tidyplots website" /></a>
 
 <!-- badges: start -->
-
-[![Lifecycle:
-experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
 <!-- badges: end -->
 
-## Overview
-
-tidyplots is an opinionated plotting package that makes to it
-ridiculously simple to create ready-to-use plots for scientific papers.
-It works by gradually adding and adjusting plot components and provides
-full control over composition, style, and absolute sizes. tidyplots is
-powered by the pipe `%>%` and provides a clean and minimalist interface
-for commonly used scientific plotting routines.
+tidyplots streamlines the creation of publication-ready plots for
+scientific papers, making it incredibly easy to incorporate and refine
+plot elements. It allows precise control over composition, style, and
+absolute sizes, while its utilization of the pipe `%>%` simplifies the
+construction of powerful plotting pipelines.
 
 ## Installation
 
-You can install the development version of `tidyplots` from
-[GitHub](https://github.com/) with:
-
 ``` r
-# install.packages("devtools")
-devtools::install_github("jbengler/tidyplots")
+# install.packages("pak")
+pak::pak("jbengler/tidyplots")
 ```
 
-## Example
+## Usage
 
-This is a basic example which shows you how to solve a common problem:
+This is a basic example which shows you how to create a simple plot.
 
 ``` r
 library(tidyplots)
@@ -39,11 +30,12 @@ study %>%
   tidyplot(x = treatment, y = score, color = treatment) %>% 
   add_mean_bar(alpha = 0.3) %>% 
   add_error() %>% 
-  add_jitter()
+  add_jitter() %>% 
+  save_plot("my_plot.pdf")
 ```
 
-<img src="man/figures/README-example-1.png" style="display: block; margin: auto;" />
+<img src="man/figures/README-unnamed-chunk-3-1.png" style="display: block; margin: auto;" />
 
-## Learn more
+## Documentation
 
 <https://jbengler.github.io/tidyplots/>

_pkgdown.yml

@@ -5,7 +5,7 @@ template:
 reference:
 - title:
   desc: >
-    To create a plot, you start with the `tidyplot()` function. Then you call `add_funs()`, `adjust_funs()`, `theme_funs()` and `remove_funs()`, preferably in that order. `split_plot()` must be last in this sequence and can only be followed by `save_plot()`.
+    To create a plot, you start with the `tidyplot()` function. Then you call `add_*()`, `adjust_*()`, `theme_*()` and `remove_*()` functions, preferably in that order. `split_plot()` must be last in this sequence and can only be followed by `save_plot()`.
 - title: Create
 - contents:
   - tidyplot
@@ -72,7 +72,7 @@ reference:
   - starts_with("adjust_flip")
   - starts_with("adjust_annotation")
 - title: Themes
-  desc: Style the plot to your liking.
+  desc: Choose and modify a theme.
 - contents:
   - starts_with("theme")
   - starts_with("remove")