Data science team repo

If you have any questions or need help, please contact anyone from the Data Science team.

This repo features:

• Presentations the team have delivered
• A website/ blog that the data science team can use to blog and compile other forms of resources
• Guidance on good coding practices, also known as a "style guide"

Contributing to this repo

All members of the Strategy Unit organisation on Github should be able to contribute to this repository.

1. Create an issue for the thing you want to add on GitHub
2. Clone the repository (in RStudio, File > New Project > Checkout a project from a version controlled repository). Paste in the URL of this repository.
3. Check out the main branch and check it's up to date in the RStudio Terminal (type git checkout main && git pull in terminal)
4. Check out a new branch (git checkout -b issue-number in terminal)

How to create a new presentation

1. Make the presentation with quarto, and put it in presentations/ in a YYYY-MM-DD_Talk-title folder. Your presentation should conform to the SU branding. It should have the filename index.qmd
2. Copy and edit the yaml header from another post to ensure you have the correct metadata (e.g. theming, author, date)

How to create a new blogpost

1. Navigate to the blogs/posts folder
2. Create a folder for your blogpost, following the naming convention YYYY-MM-DD_title-of-post
3. Copy a previous blogpost index.qmd file into your folder and use that as your template
4. Write your blogpost. To preview changes, run quarto preview path/to/index.qmd in terminal.

How to create/edit pages on the website

1. Find the .qmd file that you wish to edit. For example, if you want to add to the Style Guide page, edit the style/style_guide.qmd file.
2. If creating a new page, copy an existing .qmd file and use that as a template.
3. If you want to see how it looks before pushing to GitHub, click Render in RStudio. The HTML version of your new post should open in your browser.

Pushing your blog post/presentation/page to GitHub

1. Save your file, then add and commit it (git add file.qmd and git commit -m "Add blog post/presentation about x"). If you have any computed blocks in your content, ensure that you have run the code locally; this should generate files in the _freeze directory. You must ensure that these files are added to version control.
2. Push your content to your branch in GitHub (git push origin branchname).
3. Then, on GitHub, make a pull request to main. Put any member of the Data Science team down as a reviewer. Link your pull request with your issue by typing Closes #issuenumber in the comment field of your pull request.
4. When approved and merged to main, the Quarto page will automatically be rendered thanks to the GitHub action that has been set up.

Potential issues

The GitHub action runner does not have R installed on it, so as mentioned above, all computations must be run locally and then added to the _freeze folder.

code-fold blocks

If you have an R code block that has #| code-fold: true, then this can cause issues as quarto will need to run R with {rmarkdown} and {knitr} even when you have freeze'd the computations. You can get around this by using code-fold across the entire post (via the documents format: html options), or by doing something like:

<details>
<summary>Your code block title</summary>

[your code chunk here]
</details>

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Chris Beeley 📢 📖	Craig Parylo 📝	Dr Claire Welsh 📢	Eirini 📝	Fran Barton 📢	Jacqueline Grout 📢 📝	Matt Dray 📝 📢 📖
Rhian Davies 📝	Tom Jemmett 📝 📢 📖	YiWen Hon 📝 📢 📖	Zoë Turner 📖	sallyt-nhs 📢	sheilamomo 📝

This project follows the all-contributors specification. Contributions of any kind welcome!