Proof reading: intro to r good practice

Author: liamjberrisford

individual_modules/introduction_to_r/good_practise.ipynb

@@ -17,7 +17,7 @@
     "- Learn the importance of documenting the commands and processes used in analysis scripts for reproducibility\n",
     "- Understand the use of comments to explain the rationale behind code and improve readability without redundancy\n",
     "- Understand how to set and organize working directories to maintain a clean and navigable project structure\n",
-    "- Establish and maintain consistent coding conventions to improve code readability and mtainability\n",
+    "- Establish and maintain consistent coding conventions to improve code readability and maintainability\n",
     "- Learn to run and validate scripts from start to finish to ensure completeness and reproducibility\n",
     "\n",
     "## Becoming a proficient coder\n",
@@ -26,7 +26,7 @@
     "\n",
     "When you create your scripts there are a number of common conventions you should consider \n",
     "\n",
-    "- *Commenting (#).* When R sees a # it ignores anything that comes after in until a new line is started. So you can use to add any comments for the human reader as opposed to the computer. Because the R commands are written for the computer to read, a script containing just R code is not the easiest for a human to read. For these reason we need to add comments. There is an art to commenting effectively, often less is more. Comments should not just repeat what the code is doing they should be used to explain the reasoning behind various choices and explain things that are not obvious. \n",
+    "- *Commenting (#).* When R sees a # it ignores anything that comes after it until a new line is started. So you can use it to add any comments for the human reader as opposed to the computer. Because the R commands are written for the computer to read, a script containing just R code is not the easiest for a human to read. For these reasons we need to add comments. There is an art to commenting effectively, often less is more. Comments should not just repeat what the code is doing they should be used to explain the reasoning behind various choices and explain things that are not obvious. \n",
     "\n",
     "- *Set the working directory.* Use a command so that when you reopen your script, you know where everything is.\n",
     "\n",
@@ -35,16 +35,16 @@
     "\n",
     "- *One script per job.* It is very tempting to just add to the end of an existing script but it is more efficient and effective to limit each script  to a single task. This makes them easier to navigate but also protects from errors or bugs negatively affecting everything else downstream. \n",
     "\n",
-    "- *Don't hoard your workspace* It can be really tempting to save everything you have ever done, so you can trace back any mistakes. But an chaotic environment is hard and confusing to navigate. Identify what you really need to keep, a well maintained script should mean you can easily recreate your analysis and debug that way rather than save all the stages of the analysis.\n",
+    "- *Don't hoard your workspace* It can be really tempting to save everything you have ever done, so you can trace back any mistakes. But a chaotic environment is hard and confusing to navigate. Identify what you really need to keep. A well-maintained script should mean you can easily recreate your analysis and debug it that way rather than save all the stages of the analysis.\n",
     "\n",
     "- *Outline.* Use the outline feature in Rstudio to apply a consistent structure to all your scripts.\n",
     "\n",
-    "- *The devil is in the details* Compared to other languages R error messages can be informative, try reading them and looking for key words to indicate what the problem might be. \n",
+    "- *The devil is in the detail* Compared to other languages R error messages can be informative; try reading them and looking for key words to indicate what the problem might be. \n",
     "\n",
-    "- *Google it out* If you want to do something complicated chances are somebody else has tried before. Google for solutions to your problems. If there is no solution, use Stackoverflow.\n",
+    "- *Google it out.* If you want to do something complicated, chances are somebody else has tried before. Google for solutions to your problems. If there is no solution, use Stackoverflow.\n",
     "\n",
     "\n",
-    "- *Create a pseudocode.* Start your script by setting up the titles of your sections. Then progresively, populate the sections with subtitles and lastly, fill out your code with commands. Normally, I would add the sections: Set up, Data, Data Cleaning, Data analysis, Data plotting, and Wrap up. \n",
+    "- *Create a pseudocode.* Start your script by setting up the titles of your sections. Then progressively, populate the sections with subtitles, and lastly, fill out your code with commands. Normally, I would add the sections: Set up, Data, Data Cleaning, Data analysis, Data plotting, and Wrap up. \n",
     "\n",
     "## Structuring your data and analysis \n",
     "\n",
@@ -84,12 +84,12 @@
     "## Organizing your working directory\n",
     "\n",
     "Using a consistent folder structure across your projects will\n",
-    "help keep things organized, and will also make it easy find/file things in the\n",
+    "help keep things organized, and will also make it easier to find/file things in the\n",
     "future. This can be especially helpful when you have multiple projects. In\n",
     "general, you may create directories (folders) for **scripts**, **data**, and\n",
     "**documents**.\n",
     "\n",
-    " - **`data/`** Use this folder to store your raw data and intermediate\n",
+    " - **`data/`** Use this folder to store the raw data and intermediate\n",
     "   datasets you may create for the need of a particular analysis. For the sake\n",
     "   of transparency and [provenance](https://en.wikipedia.org/wiki/Provenance),\n",
     "   you should *always* keep a copy of your raw data accessible and do as much\n",
@@ -113,7 +113,7 @@
     "# Performing reproducible analyses\n",
     "\n",
     "Once you are happy with your script or analysis, it is highly recommended that you run the whole script from top to bottom in one execution.\n",
-    "This ensures that your script is complete and that your record of what you did is accurate. It can be very easy when developing a script by copying and pasting chunks of code, to forget to record something, or to run commands out of order. This may have an effect on the final output, and it may be impossible to work out what happened or why, or you may even not be aware of the effect. For this reason, we recommend rerunning your script at the end. If something goes wrong, and you get an error or a warning you know, you've missed a step out or need to fix it. \n",
+    "This ensures that your script is complete and that your record of what you did is accurate. It can be very easy when developing a script by copying and pasting chunks of code, to forget to record something, or to run commands out of order. This may have an effect on the final output, and it may be impossible to work out what happened or why, or you may even not be aware of the effect. For this reason, we recommend rerunning your script at the end. If something goes wrong, and you get an error or a warning, you know you've missed a step out or need to fix it. \n",
     "\n",
     "Most importantly, if you detect the mistake further down the line, it will be much easier to troubleshoot because you know that your script is a genuine\n",
     "reflection of what you did to the data, rather than an incomplete record of some of the steps you ran, in some order. \n",

individual_modules/introduction_to_r/questions/summary_good_practise.json

@@ -35,7 +35,7 @@
                 "feedback": "Incorrect"
             },
             {
-                "answer": "To ensure all file paths are correctly references and the project is organised",
+                "answer": "To ensure all file paths are correctly referenced and the project is organised",
                 "correct": true,
                 "feedback": "Correct"
             },