tidystats Word add-in
The tidystats Word add-in is an add-in for Microsoft Word to insert statistics from a file created with the tidystats R package.
Requirements
You need the following to use add-in:
- An internet connection (the add-in is a web app that runs inside of Word)
- A compatible version of Microsoft Word:
- Word for iPad
- Word 2016 for Mac
- Word Online
- Word 2013 or later
- Word 2016 or later
For more information on the requirements, see here.
Privacy Policy
The tidystats Word add-in is like a mini-website that runs in your Word document. This means that when you start the add-in, a connection is made to a server in order to retrieve the content of the add-in. Once downloaded, however, the add-in runs entirely on your computer and no information is shared with the server. The content of your Word document are not saved, nor are the statistics you upload.
For more information on privacy and security for Office add-ins, please see this page.
Usage
Before you can use the tidystats Word add-in, you must create a file containing your statistics using the tidystats R package. For details on how to do this, please see the website of tidystats.
If you simply want to try out the add-in, you can also use this example file.
Once you have a file created with tidystats and you want to insert the statistics into your document, go to the Insert pane of your Word document and click on 'Insert Statistics'.
Next, click on 'Choose a file' and select the file you created with tidystats.
This should reveal a list of your analyses, each with a name that identifies your analyses. You can use the Search textbox to search for your analyses. Click on one of the analyses to reveal its statistics. You can then click on the name of a statistic or set of statistics to insert them into your document.
If you want to update the statistics, simply choose a new file and click on the 'Update statistics' button. Note that this does require that your analyses have the same identifier as in the previous file.
Finally, if you found the add-in useful, please cite the work. You can use the citation buttons to quickly insert a citation; thanks!
Supported statistical tests
The following statistical tests, in R, are supported:
Package: stats
t.test()cor.test()chisq.test()wilcox.test()fisher.test()oneway.test()aov()lm()
More resources
Please see the following links for more information on how to use tidystats R package.
If you have any questions about how to use tidystats, or suggestions for improvements, you can contact me on Twitter or via e-mail.
Testing
The current release version of the add-in is 1.0. This means that the add-in is sort of feature complete, but there is still a lot of room for improvements and new features. If you want to help test these newer versions, you can install the development version of the add-in. For instructions on how to do this, see below.
Installing the development version of tidystats for Word
Download one of the manifest files. This is the file that needs to be installed on your computer somewhere in order to run the add-in. Download the local manifest file if you can host the web-app yourself; download the netlify manifest file for the most recent version of tidystats; and download the web manifest file for the latest official release version of tidystats.
Mac
To install the add-in in Mac, see the 'Sideload an add-in in Office on Mac' section here. Briefly put, you need to put the manifest file in the following folder:
/Users/<username>/Library/Containers/com.microsoft.Word/Data/Documents/wef
If the 'wef' folder does not exist yet, simply create it and put the manifest file inside. After doing that, you can access the add-in via Insert ribbon > Add-ins > My Add-ins (click on the dropdown arrow; only then will you see the Developer add-ins). You should see the tidystats add-in in the list. Simply click on it and the add-in will open.
That's it for Mac <3.
Windows
To install the add-in in Windows, see this webpage. When you copy the path to the shared folder, make sure it is a valid path (When I copied the path in step 5 of 'Share a folder' it also added some extra text to the front and end of the path).
Bugs and feature requests
Found a bug or got an idea about how to improve the add-in? Please create a Github issue. If you need some help figuring out how this works, see this support page by Github or simply contact me on Twitter or send me an e-mail.