From e4ba48f199f695bcc90059e998d7e238ecccc5bc Mon Sep 17 00:00:00 2001 From: James McMahon Date: Wed, 27 Sep 2023 11:54:27 +0100 Subject: [PATCH] Fix some minor typos in the README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index abf18bb..603590a 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ If you encounter any issues with the automatic installation of package dependenc install.packages(c("flextable", "officer")) ``` -A further option is to install this package using [drat](https://github.com/eddelbuettel/drat). The advantage of this method is that it should work from within the PHS network but the disadvantage is that it may not always be completely in sync with the latest version of the package on Github. Note that the first line to install the drat package is only needed if you don't already have it installed. +A further option is to install this package using [drat](https://github.com/eddelbuettel/drat). The advantage of this method is that it should work from within the PHS network but the disadvantage is that it may not always be completely in sync with the latest version of the package on GitHub. Note that the first line to install the drat package is only needed if you don't already have it installed. ```{r drat-installation, eval = FALSE} install.packages("drat") @@ -44,7 +44,7 @@ install.packages("phstemplates") ## Making a new PHS project To use this project template, install the package by following the instructions above. After doing this you will then be able to create new R projects with the recommended PHS structure within RStudio by clicking **File -> New Project... -> New Directory** and selecting **PHS R Project Template**. Name the project and select a location for the project folder. The original author can also be input - this will automatically add the name to the top section of default scripts within the project. You can then edit the files and folders as appropriate, e.g. rename the R script files or create new sub-folders. The default files and folders contained within the project are described in subsequent sections of this README. -This template aims to instil best practice within PHS and therefore git has been initialised for version control. However, if you are not using this then you can delete the .gitignore file. More information about [version control](https://github.com/Public-Health-Scotland/resources/blob/master/version-control.md). +This template aims to instill best practice within PHS and therefore git has been initialised for version control. However, if you are not using this then you can delete the .gitignore file. More information about [version control](https://github.com/Public-Health-Scotland/resources/blob/master/version-control.md). If you are using git for version control then please be aware that the .gitignore contains the minimum recommended file types and folders to stop data being tracked and pushed to GitHub. Further guidance on using git and GitHub securely can be found [here](https://github.com/Public-Health-Scotland/GitHub-guidance).