From 0c01c4cc76a78a6a69f68a4dfb43d09a663fb73c Mon Sep 17 00:00:00 2001 From: Daniel Date: Tue, 14 May 2024 08:04:26 +0200 Subject: [PATCH] update readme --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3c75f99..389c8a4 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,18 @@ Collection of convenient functions for common statistical computations, which are not directly provided by R's base or stats packages. -This package aims at providing, **first**, shortcuts for statistical measures, which otherwise could only be calculated with additional effort (like Cramer's V, Phi, or effict size statistics like Eta or Omega squared), or for which currently no functions available. +This package aims at providing, **first**, shortcuts for statistical measures, which otherwise could only be calculated with additional effort (like Cramer's V, Phi, or effict size statistics like Eta or Omega squared), or for which currently no functions are available. -**Second**, another focus lies on weighted variants of common statistical measures and tests like weighted standard error, mean, t-test, correlation, and more. +**Second**, another focus lies on implementations of common statistical significance tests with a consistent syntax, like t-test, Mann-Whitney test, Chi-squared test, and more. These functions are designed to be more user-friendly and also support weights, i.e. weighted statistics can be calculated. + +**Finally**, the package includes miscellaneous functions that are either not yet available in R (like `svyglm.nb()` or `svyglm.zip()` to calculate negative binomial or zero-inflated poisson models for survey data) or are just convenient for daily work (like functions for bootstrapping, or ANOVA summary tables). The comprised tools include: * Especially for mixed models: design effect, sample size calculation -* Weighted statistics and tests for: mean, median, standard error, standard deviation, correlation, Chi-squared test, t-test, Mann-Whitney-U-test +* Significance tests: Correlation, Chi-squared test, t-test, Mann-Whitney-U test, Wilcoxon rank sum test, Kruskal-Wallis test. + +Note that most functions that formerly were available in this package have been moved to the [**easystats** project](http://easystats.github.io/easystats). ## Documentation @@ -24,8 +28,8 @@ Please visit [https://strengejacke.github.io/sjstats/](https://strengejacke.gith To install the latest development snapshot (see latest changes below), type following commands into the R console: ```r -library(devtools) -devtools::install_github("strengejacke/sjstats") +library(remotes) +remotes::install_github("strengejacke/sjstats") ``` ### Officiale, stable release