FAQ.md

In trinker/reports: An R Package to Assist in the Workflow of Writing Academic Articles and Other Reports

Frequently Asked Questions

This FAQ is compiled from the issues and messages I received from blog posts and emails, etc.

1. reports does not work...
2. Please first update all your R packages (use update.packages()) and probably R itself (what is the current R version?), then see if it works; if not...
3. If this still does not fix the problem please file an issue report
4. What is the best place to ask questions when the package website or vignette is not helpful?
5. Depending what you want to ask, you may use these tools:
   • StackOverflow (Recommended): general questions (more experts and quicker answers there).
   • Github issues: bug reports and feature requests.
   • Email me at [e-mail] - this is the least recommended way unless this is really private issue.
6. How should I get started?
7. Watch the intro video
8. Look at the qick start slides
9. Read the vignette on the GitHub homepage
10. Do you recommend an editor for working with R and reports?
11. Hands down RStudio. The reports packages was designed to work with RStudio.
12. I also use WinEdt for Windows and TexMaker. for Linux Mint, but I think the LaTeX editor you use should be comfortable to you.
13. How can I submit a documentation fix or other minor change?
14. Navigate to the file within the repo
15. Click on the edit button
16. Make the necessary changes
17. Add a descriptive commit summary and click on propose file change
18. Submit the pull request
19. How can I learn more about slidify?
20. slidify Website
21. GitHub
22. Examples
23. How can I learn more about knitr?
24. knitr Website
25. GitHub
26. Examples

trinker/reports documentation built on May 31, 2019, 9:51 p.m.