Code Review, Please

[ctesta01]

Please Review My Documentation and Code

I would like to ask that if you have some amount of time you could invest in the QualtricsTools project that you help me review some of the documentation, code, or guides that I have written.
I am including a sample of suggested material that I would love some feedback on. Please pick a single item, or a couple if you'd like, and let me know how I could improve them.

Specific questions you might keep in mind:

• Does the documentation explain why you might need that function/parameter/item?
• Do you understand why we need the function, code, logic, or web-app-component that you're reviewing?
• Do you see relevant functionalities that are not explained/mentioned somewhere they should be?
• Is the code clear, readable, concise, etc?

Extra bonus points:

• Could the code be written such that it runs faster?
• Can the code be simplified/improved/reduced?

Documentation:

Easier:

• The QualtricsTools package README.md
  • The README in a package is the recommended first location that new users look when viewing the package on GitHub or downloading it for the first time. It should be concise and informative, with answers to the most easily anticipated questions someone might have downloading the package for the first time.
• Frequently Asked Questions
• Generating Results Tables
• Generating Text Appendices
• The Shiny App : Explaining the App Components
  • For an easy task, just look at the first section of this page. The "Understanding the Code" section is much more technical, and listed below as a harder task.
• Appendix of Qualtrics Terms

Harder:

• The Source Code Layout Guide
• Exporting to Different Filetypes
• The Shiny App : Understanding the Code
• Explanations of Important Functions

Code:

Easier (Still Subtle, though):

• loading_files.R
• get_coded_questions_and_blocks inside reorganizing_survey_data.R
• clean_html inside reorganizing_survey_data.R
• mc_single_answer_results in results_generation.R
• mc_multiple_answer_results in results_generation.R
• generate_results in results_generation.R
• get_setup in helper_functions.R
• make_results_tables in helper_functions.R
• make_text_appendices in helper_functions.R

Harder:

• matrix_single_answer_results in results_generation.R
• matrix_multiple_answer_results in results_generation.R
• /inst/shiny/server.R
• link_responses_to_questions in reorganizing_survey_data.R
• split_respondents in reorganizing_survey_data.R
• tabelize_blocks in html_results.R
• text_appendices_table in html_results.R