{"Package":"sigr","Type":"Package","Title":"Succinct and Correct Statistical Summaries for Reports","Version":"1.1.5","Date":"2023-08-19","Authors@R":"c(\nperson(\"John\", \"Mount\", email = \"jmount@win-vector.com\", role = c(\"aut\", \"cre\")),\nperson(\"Nina\", \"Zumel\", email = \"nzumel@win-vector.com\", role = c(\"aut\")),\nperson(family = \"Win-Vector LLC\", role = c(\"cph\"))\n)","URL":"https://github.com/WinVector/sigr/,\nhttps://winvector.github.io/sigr/","Maintainer":"John Mount ","BugReports":"https://github.com/WinVector/sigr/issues","Description":"Succinctly and correctly format statistical summaries of\nvarious models and tests (F-test, Chi-Sq-test, Fisher-test, T-test, and rank-significance).\nThis package also includes empirical tests, such as Monte Carlo and bootstrap distribution estimates.","License":"GPL-2 | GPL-3","RoxygenNote":"7.2.3","Depends":"R (>= 3.2.1)","Imports":"wrapr (>= 2.0.9), stats","Suggests":"pwr, parallel, knitr, rmarkdown, tinytest","VignetteBuilder":"knitr","ByteCompile":"true","NeedsCompilation":"no","Packaged":"2023-08-20 00:09:29 UTC; johnmount","Author":"John Mount [aut, cre],\nNina Zumel [aut],\nWin-Vector LLC [cph]","Repository":"CRAN","Date/Publication":"2023-08-20 02:20:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/sigr_1.1.5.tar.gz","jsonAuthors":[{"name":"John Mount","email":"jmount@win-vector.com","maintainer":true},{"name":"Nina Zumel","email":"nzumel@win-vector.com","maintainer":false},{"name":" Win-Vector LLC","email":null,"maintainer":false}],"readme":"\n[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/sigr)](https://cran.r-project.org/package=sigr)\n[![status](https://tinyverse.netlify.com/badge/sigr)](https://CRAN.R-project.org/package=sigr)\n\n\n\n# sigr\n\nConcise formatting of significances in R.\n\n![](https://github.com/WinVector/sigr/raw/master/tools/sigr.png)\n\nPlease see [Adding polished significance summaries to papers using\nR](https://win-vector.com/2016/10/04/adding-polished-significance-summaries-to-papers-using-r/)\nfor some discussion.\n\nSee also:\n\n- [“The prevalence of statistical reporting errors in psychology\n (1985–2013)”, Nuijten, M.B., Hartgerink, C.H.J., van Assen, M.A.L.M.\n et al., Behav Res (2015),\n doi:10.3758/s13428-015-0664-2](https://link.springer.com/article/10.3758/s13428-015-0664-2)\n- Reporting Statistics in APA Style\n- [Publication Manual of the American Psychological Association, Seventh\n Edition](https://apastyle.apa.org/products/publication-manual-7th-edition)\n- [Proofing statistics in\n papers](https://win-vector.com/2016/10/02/proofing-statistics-in-papers/)\n- [apa](https://CRAN.R-project.org/package=apa)\n- [bootstrap](https://CRAN.R-project.org/package=bootstrap)\n- [broom](https://cran.r-project.org/package=broom)\n- [achetverikov/APAstats](https://github.com/achetverikov/APAstats)\n- [pwr](https://CRAN.R-project.org/package=pwr)\n- [ggstatsplot](https://indrajeetpatil.github.io/ggstatsplot/)\n- [“Why Most Published Research Findings Are False”, John P. A.\n Ioannidis PLOS Medicine, August 30,\n 2005](https://journals.plos.org/plosmedicine/article?id=10.1371/journal.pmed.0020124)\n- [“The garden of forking paths”, Andrew Gelman and Eric Loken, 14 Nov\n 2013](http://www.stat.columbia.edu/~gelman/research/unpublished/p_hacking.pdf)\n\n------------------------------------------------------------------------\n\n*sigr* is a small package that concentrates on computing summary\nstatistics and reporting in an appropriate format.\n\nFor example here is formatting the quality of a logistic regression.\n\n``` r\nd <- data.frame(x=c(1,2,3,4,5,6,7,7),\n y=c(TRUE,FALSE,FALSE,FALSE,TRUE,TRUE,TRUE,FALSE))\nmodel <- glm(y~x,data=d,family=binomial)\nsummary(model)\n```\n\n ## \n ## Call:\n ## glm(formula = y ~ x, family = binomial, data = d)\n ## \n ## Coefficients:\n ## Estimate Std. Error z value Pr(>|z|)\n ## (Intercept) -0.7455 1.6672 -0.447 0.655\n ## x 0.1702 0.3429 0.496 0.620\n ## \n ## (Dispersion parameter for binomial family taken to be 1)\n ## \n ## Null deviance: 11.090 on 7 degrees of freedom\n ## Residual deviance: 10.837 on 6 degrees of freedom\n ## AIC: 14.837\n ## \n ## Number of Fisher Scoring iterations: 4\n\n``` r\nlibrary(\"sigr\")\n```\n\n``` r\ncat(render(wrapChiSqTest(model),\n pLargeCutoff=1, format='markdown'))\n```\n\n**Chi-Square Test** summary: *pseudo-R²*=0.02282\n(χ²(1,*N*=8)=0.2531, *p*=0.6149).\n\n------------------------------------------------------------------------\n\nTo install, from inside `R` please run:\n\n``` r\ninstall.packages(\"sigr\")\n```","jobInfo":{"package":"sigr","version":"1.1.5","parsingStatus":"success","parserVersion":2,"parsedAt":"2023-08-20T04:30:21+0000"}}

Description

Usage

Arguments

Value

Examples