README.md

This repo contains code for the Transport Data Science module at the Institute for Transport Studies, University of Leeds. See the website at https://itsleeds.github.io/tds/ and at leeds.ac.uk

Quickstart

See the course website at itsleeds.github.io/tds

The quickest way to get started with the code for many people will be to use GitHub Codespaces. Click the Open in GitHub Codespaces button above to get started.

Cloning and contributing

We welcome contributions!

To fork and clone the repo, use the following commands:

# install the gh command line tool: https://cli.github.com/
gh repo fork itsleeds/tds
git clone tds
code tds # to open in VS Code, or open in your preferred editor
# make changes
git add .
git status # to check what you've changed
git commit -m "your message"
git push
gh pr create # to create a pull request

Please create an issue before contributing, so we can discuss the changes you’d like to make.

You can create and work on an issue with the following commands:

gh repo clone itsleeds/tds
cd tds # or code tds to open with VS Code
gh issue create # to create an issue
gh issue develop 123 --checkout # to create a branch and start working on issue 123
# make changes
git add .
git commit -m "your message"
git push
gh pr create # to create a pull request

Archive

See an archived version of the repo, before we switched to using Quarto, at https://github.com/itsleeds/tdsarchive

Setup

To set it up we used commands such as:

usethis::use_description()
usethis::use_package("stats19")
usethis::use_package("DT")
usethis::use_package("quarto")

You can save presentations as PDF files with the following command:

See documentation on Quarto website for info on publishing.