diff options
| -rw-r--r-- | .Rbuildignore | 1 | ||||
| -rw-r--r-- | R/corplot.R | 1 | ||||
| -rw-r--r-- | README.Rmd | 56 | ||||
| -rw-r--r-- | README.md | 55 | ||||
| -rw-r--r-- | man/figures/README-pressure-1.png | bin | 0 -> 7879 bytes |
5 files changed, 111 insertions, 2 deletions
diff --git a/.Rbuildignore b/.Rbuildignore index 5163d0b..2a2cb83 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1 +1,2 @@ ^LICENSE\.md$ +^README\.Rmd$ diff --git a/R/corplot.R b/R/corplot.R index c18e904..cccc6de 100644 --- a/R/corplot.R +++ b/R/corplot.R @@ -61,6 +61,7 @@ corplot <- function(R, title = NULL){ mid = 'white', high = 'blue', midpoint = 0, + limits = c(-1, 1), name = expression(rho) ) + ggplot2::scale_x_discrete(limits = rev(levels(df$i))) + diff --git a/README.Rmd b/README.Rmd new file mode 100644 index 0000000..7551e05 --- /dev/null +++ b/README.Rmd @@ -0,0 +1,56 @@ +--- +output: github_document +--- + +<!-- README.md is generated from README.Rmd. Please edit that file --> + +```{r, include = FALSE} +knitr::opts_chunk$set( + collapse = TRUE, + comment = "#>", + fig.path = "man/figures/README-", + out.width = "100%" +) +``` + +# rcsobczak + +<!-- badges: start --> +<!-- badges: end --> + +The goal of rcsobczak 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/rcsobczak') +``` + +## Example + +This is a basic example which shows you how to solve a common problem: + +```{r example} +library(rcsobczak) +## basic example code +``` + +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. @@ -1,3 +1,54 @@ -# r -This package is a collection of my personal useful functions such as standard ggplot themes and other tricks.
\ No newline at end of file +<!-- README.md is generated from README.Rmd. Please edit that file --> + +# rcsobczak + +<!-- badges: start --> + +<!-- badges: end --> + +The goal of rcsobczak 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/rcsobczak') +``` + +## Example + +This is a basic example which shows you how to solve a common problem: + +``` r +library(rcsobczak) +## basic example code +``` + +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" alt="" 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/man/figures/README-pressure-1.png b/man/figures/README-pressure-1.png Binary files differnew file mode 100644 index 0000000..e2fdf6d --- /dev/null +++ b/man/figures/README-pressure-1.png |
