diff --git a/.Rbuildignore b/.Rbuildignore index 5aaffd82..f809dcf3 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -28,7 +28,6 @@ publication/* ^\.httr-oauth$ ^CRAN-RELEASE$ tests\^spelling -^LICENSE ^\.lintr$ ^\.circleci$ ^tests/manual$ @@ -52,4 +51,5 @@ hextools \.code-workspace$ # Flip these two to no build vignettes: # ^vignettes/(?!additional).* -^vignettes/additional \ No newline at end of file +^vignettes/additional +^LICENSE\.md$ diff --git a/DESCRIPTION b/DESCRIPTION index 54e95fb2..5c10ce47 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Type: Package Package: effectsize Title: Indices of Effect Size -Version: 0.8.6.1 +Version: 0.8.6.2 Authors@R: c(person(given = "Mattan S.", family = "Ben-Shachar", diff --git a/LICENSE b/LICENSE index ea50e788..f3dcba36 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,2 @@ -# MIT License - -Copyright (c) 2023 easystats team - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file +YEAR: 2023 +COPYRIGHT HOLDER: effectsize authors diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..b5aac20e --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# MIT License + +Copyright (c) 2023 effectsize authors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index b4ff4a0c..d610f50c 100644 --- a/README.md +++ b/README.md @@ -54,22 +54,24 @@ Click on the buttons above to access the package [**easystats blog**](https://easystats.github.io/blog/posts/), and check-out these vignettes: -- **Effect Sizes** - - [**Standardized - Differences**](https://easystats.github.io/effectsize/articles/standardized_differences.html) - - [**For Contingency - Tables**](https://easystats.github.io/effectsize/articles/xtabs.html) - - [**ANOVA Effect - Sizes**](https://easystats.github.io/effectsize/articles/anovaES.html) -- **Effect Sizes Conversion** - - [**Between Effect - Sizes**](https://easystats.github.io/effectsize/articles/convert_r_d_OR.html) - - [**Between Probabilities and Odds and Risk - Ratios**](https://easystats.github.io/effectsize/articles/convert_p_OR_RR.html) - - [**Effect Size from Test - Statistics**](https://easystats.github.io/effectsize/articles/from_test_statistics.html) -- [**Automated Interpretation of Indices of Effect - Size**](https://easystats.github.io/effectsize/articles/interpret.html) +- **Effect Sizes** + - [**Standardized + Differences**](https://easystats.github.io/effectsize/articles/standardized_differences.html) + - [**For Contingency + Tables**](https://easystats.github.io/effectsize/articles/xtabs.html) + - [**ANOVA Effect + Sizes**](https://easystats.github.io/effectsize/articles/anovaES.html) +- **Effect Sizes Conversion** + - [**Between Effect + Sizes**](https://easystats.github.io/effectsize/articles/convert_r_d_OR.html) + - [**Between Probabilities and Odds and Risk + Ratios**](https://easystats.github.io/effectsize/articles/convert_p_OR_RR.html) + - [**Effect Size from Test + Statistics**](https://easystats.github.io/effectsize/articles/from_test_statistics.html) +- [**Plotting Functions for the ‘effectsize’ + Package**](https://easystats.github.io/see/articles/effectsize.html) +- [**Automated Interpretation of Indices of Effect + Size**](https://easystats.github.io/effectsize/articles/interpret.html) # Features @@ -122,7 +124,7 @@ language effect sizes* and more… ### Contingency Tables ``` r -# Dependence +# Dependence phi(mtcars$am, mtcars$vs) ## ϕ (adj.) | 95% CI ## ----------------------- @@ -143,7 +145,7 @@ fei(table(mtcars$cyl), p = c(0.1, 0.3, 0.6)) ## ------------------- ## 0.27 | [0.17, 1.00] ## -## - Adjusted for non-uniform expected probabilities. +## - Adjusted for uniform expected probabilities. ## - One-sided CIs: upper bound fixed at [1.00]. ``` @@ -256,9 +258,9 @@ interpret_cohens_d(d = 0.45, rules = "gignac2016") In order to cite this package, please use the following citation: -- Ben-Shachar M, Lüdecke D, Makowski D (2020). effectsize: Estimation - of Effect Size Indices and Standardized Parameters. *Journal of Open - Source Software*, *5*(56), 2815. doi: 10.21105/joss.02815 +- Ben-Shachar M, Lüdecke D, Makowski D (2020). effectsize: Estimation of + Effect Size Indices and Standardized Parameters. *Journal of Open + Source Software*, *5*(56), 2815. doi: 10.21105/joss.02815 Corresponding BibTeX entry: diff --git a/man/effectsize.Rd b/man/effectsize.Rd index 7770ab81..5d931c82 100644 --- a/man/effectsize.Rd +++ b/man/effectsize.Rd @@ -22,7 +22,7 @@ effectsize(model, ...) \item{type}{The effect size of interest. See details.} \item{ci}{Value or vector of probability of the CI (between 0 and 1) -to be estimated. Default to \code{.95} (\verb{95\%}).} +to be estimated. Default to \code{0.95} (\verb{95\%}).} \item{test}{The indices of effect existence to compute. Character (vector) or list with one or more of these options: \code{"p_direction"} (or \code{"pd"}), @@ -32,7 +32,7 @@ For each "test", the corresponding \pkg{bayestestR} function is called (e.g. \code{\link[bayestestR:rope]{rope()}} or \code{\link[bayestestR:p_direction]{p_direction()}}) and its results included in the summary output.} -\item{verbose}{Toggle warnings and messages on or off.} +\item{verbose}{Toggle off warnings.} \item{...}{Arguments passed to or from other methods. See details.} }