Repository files navigation

⁠

Check out what’s new.

Lovesummarytools? Share the love,buy me acoffee!

summarytools is a anR package fordata cleaning, exploring, and simple reporting. The package wasdeveloped with the following objectives in mind:

• Provide a coherent set of easy-to-use descriptive functions akin tothose included in commercial statistical software suites such as SAS,SPSS, and Stata
• Offer flexibility in terms of output format & content
• Integrate well with commonly used software & tools for reporting (theRStudio IDE,Rmarkdown,Quarto, andknitr) while also allowing for standalone,simple report generation using any R interface

On a more personal level, I simply wish to share with the R communityand the scientific community at large the functions I first developedfor myself, but realized would benefit others who are facing similarchallenges when dealing daily with (often messy) data.

The bulk of the technical documentation can now be found in thefollowing vignettes:

Introduction tosummarytools|CRANversion
Summarytools in RMarkdown|CRANVersion
PDFManual(automatically generated by CRAN)

Additional software is used bysummarytools for fine-tuning graphicsas well as offering interactive functionality. If you are installingsummarytools for the first time, click on the relevant link to getOS-specific instructions. On Windows, no additional software isrequired.

Mac OS X
Ubuntu / Debian / Mint
Older Ubuntu (14 and 16)
Fedora / Red Hat / CentOS
Solaris

This method has the advantage of benefiting from minor fixes andimprovements that are added between CRAN releases. Its main drawback isthat you won’t be noticed when a new version is available. You caneither check this page from time to time, or best, use a package thatchecks for package updates on various repositories, such asdtupdate andDrat.

install.packages("remotes")# Using devtools or pak is also possiblelibrary(remotes)install_github("rapporter/pander")# Strongly recommendedinstall_github("dcomtois/summarytools",build_vignettes=TRUE)

CRAN versions are stable but are not updated as often as the GitHubversions. On the plus side, they can be easier to install on somesystems.

install.packages("summarytools")

• Version 1.1.0 introduced a few significant improvements, aside fromthe bug fixes.

  • Instby(), theuseNA parameter can be used to generateadditional groupings for observations where the grouping variable(s)areNA
  • Labelled vectors fromhaven &labelled are treated likefactors byfreq() (always) anddfSummary() (only when all valueshave labels; this is to avoid generating factors with countlessnumerical levels).
  • descr() is more flexible with the stats parameters; you can forinstance usestats = c("all", -"kurtosis") if you need everythingexcept kurtosis
  • The helper functionzap_attr() turns results into simple matrices,adding an alternative totb() when you need to work further withthe results
  • A newna.val parameter was added tofreq(),ctable() anddfSummary(), which allows treating a particular character value orfactor level asNA. One common instance would be “” (empty string)for character vectors.
  • Sampling weights were a bit buggy with by-groups, and so wastb()withfreq() results. This is now a thing of the past.
  • See the package’s NEWS for more details:news(package="summarytools")

• IndfSummary() since 1.0.1:

  • It is possible to control which statistics to show in theFreqs /Values column (seehelp("st_options", "summarytools") forexamples)
  • Inhtml outputs, tables are better aligned horizontally(categories >> counts >> charts); if misalignment occurs,adjustinggraph.magnif should resolve it
  • List-type columns andInf values are handled properly

For more details, seevignette("introduction", "summarytools") as wellasnews(package = "summarytools").

• XQuartz
• Magick++

Magick++ can be installed usingHomebrew orMacports.

Back to installation instructions

Magick++
sudo apt install libmagick++-dev

Back to installation instructions

This applies only if you are using Ubuntu Trusty (14.04) or Xenial(16.04).

Magick++

sudo add-apt-repository -y ppa:opencpu/imagemagicksudo apt-get updatesudo apt-get install -y libmagick++-dev

Back to installation instructions

Magick++
sudo yum install ImageMagick-c++-devel

Back to installation instructions

Magick++

pkgadd -d http://get.opencsw.org/now/opt/csw/bin/pkgutil -U/opt/csw/bin/pkgutil -y -i imagemagick /usr/sbin/pkgchk -L CSWimagemagick

Back to installation instructions

Ifsummarytools brings value to your work, please consider making adonation. It will bring a smile to my face and boost my productivity!Buy me a coffee, or use the PayPallink.Thanks!

A big thanks to the following people who made donations:

• Ashirwad Barnwal
• David Thomas
• Peter Nilsson
• Ross Dunne
• Igor Rubets
• Joerg Sahlmann
• Mark Friedman
• Roger Hilfiker
• Stefano Lav

The package comes with no guarantees. It is a work in progress andfeedback is always welcome. Please open anissue onGitHub if you find abug or wish to submit a feature request.

Back to top