From 75317599ef08d9fed19f2437db3b441fbc0127e4 Mon Sep 17 00:00:00 2001 From: Chris Sobczak Date: Tue, 16 Jun 2026 17:17:01 -0700 Subject: Update README --- README.Rmd | 26 ++++++-------------------- README.md | 31 ++++++++----------------------- man/figures/README-example-1.png | Bin 0 -> 5535 bytes man/figures/README-example-2.png | Bin 0 -> 66213 bytes 4 files changed, 14 insertions(+), 43 deletions(-) create mode 100644 man/figures/README-example-1.png create mode 100644 man/figures/README-example-2.png diff --git a/README.Rmd b/README.Rmd index ae300de..b383602 100644 --- a/README.Rmd +++ b/README.Rmd @@ -18,14 +18,13 @@ knitr::opts_chunk$set( -The goal of rcsobczak is to easily provide convenience functions I find useful. +The goal of csobczak.r is to easily provide convenience functions I find useful. ## Installation You can install the development version of rcsobczak like so: ``` r -# FILL THIS IN! HOW CAN PEOPLE INSTALL YOUR DEV PACKAGE? install.packages('pak') pak::pkg_install('git::https://codeberg.org/csobczak/csobczak.r') ``` @@ -35,22 +34,9 @@ pak::pkg_install('git::https://codeberg.org/csobczak/csobczak.r') This is a basic example which shows you how to solve a common problem: ```{r example} -library(rcsobczak) -## basic example code +library(csobczak.r) +X <- matrix(data = rnorm(100), nrow = 10) +R <- cor(X) +corplot(R, title = 'Example Correlation Plot') +networkplot(R, title = 'Example Network Plot') ``` - -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 589ac6f..f84a260 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ -The goal of rcsobczak is to easily provide convenience functions I find +The goal of csobczak.r is to easily provide convenience functions I find useful. ## Installation @@ -15,7 +15,6 @@ useful. You can install the development version of rcsobczak like so: ``` r -# FILL THIS IN! HOW CAN PEOPLE INSTALL YOUR DEV PACKAGE? install.packages('pak') pak::pkg_install('git::https://codeberg.org/csobczak/csobczak.r') ``` @@ -25,30 +24,16 @@ pak::pkg_install('git::https://codeberg.org/csobczak/csobczak.r') This is a basic example which shows you how to solve a common problem: ``` r -library(rcsobczak) -## basic example code +library(csobczak.r) +X <- matrix(data = rnorm(100), nrow = 10) +R <- cor(X) +corplot(R, title = 'Example Correlation Plot') ``` -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 +networkplot(R, title = 'Example Network Plot') ``` -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/man/figures/README-example-1.png b/man/figures/README-example-1.png new file mode 100644 index 0000000..7737194 Binary files /dev/null and b/man/figures/README-example-1.png differ diff --git a/man/figures/README-example-2.png b/man/figures/README-example-2.png new file mode 100644 index 0000000..92b4349 Binary files /dev/null and b/man/figures/README-example-2.png differ -- cgit v1.2.3