6 Troubleshooting
This guide cannot cover every situation. The problems below have come up more than once, with what fixed them. If you run into one that is missing, please open an issue in the source repository.
6.1 Start with the readiness report
check_publication_readiness() reads the package and names, for every item that fails, the step that closes it. Run it first whenever a later step stops with a message about a missing file.
6.2 setup_dictionary() stops because the dictionary exists
Run update_dictionary() instead. It brings the dictionary in line with the data and keeps every description you wrote (Chapter 2).
6.3 setup_website() stops because README.md is missing
The website is built from the README. Run setup_readme() and devtools::build_readme() first (Chapter 4).
6.4 pkgdown reports “URLs not ok”
The address of the site is missing from DESCRIPTION. Add it with desc::desc_add_urls() and the value of the url line of _pkgdown.yml, then build again (Chapter 4).
6.5 Git fails when pushing large files
When you push large files such as raw datasets, Git may fail. Raise the buffer size with the following line in the Terminal, from the folder of your project:
git config http.postBuffer 5242880006.6 R CMD check
A few messages from devtools::check() come up again and again.
“unable to verify current time” relates to the time synchronisation of your computer. This Stack Overflow answer has the fix.
“Non-standard files/directories found at top level” means that the package root holds files R does not expect there. The fix is to list them in .Rbuildignore, as this Stack Overflow thread explains. The washr functions add their own files to .Rbuildignore, so this message points at a file you added.
Platforms change their interfaces from time to time, so a button or a menu named in this guide may have moved. The documentation of the platform is the place to look then.