An open API service indexing awesome lists of open source software.

https://github.com/ITSLeeds/TDS

Transport Data Science, a post-graduate module at the University of Leeds' Institute for Transport Studies
https://github.com/ITSLeeds/TDS

course education module msc python-data-science rstats transportation-planning

Last synced: 10 months ago
JSON representation

Transport Data Science, a post-graduate module at the University of Leeds' Institute for Transport Studies

Awesome Lists containing this project

README

          

[![pages-build-deployment](https://github.com/itsleeds/tds/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/itsleeds/tds/actions/workflows/pages/pages-build-deployment)
[![Open in GitHub
Codespaces](https://img.shields.io/badge/Open%20in-GitHub%20Codespaces-blue?logo=github.png)](https://github.com/codespaces/new/itsleeds/tds?quickstart=1)
[![Docker Image
Size](https://ghcr-badge.egpl.dev/itsleeds/tds/size?color=%2344cc11&tag=latest&label=image+size&trim=.png)](https://github.com/itsleeds/tds/pkgs/container/tds)

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](https://webprod3.leeds.ac.uk/catalogue/dynmodules.asp?Y=202223&M=TRAN-5340M)

## Quickstart

See the course website at
[itsleeds.github.io/tds](https://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](https://github.com/codespaces/new/itsleeds/tds?quickstart=1)
button above to get started.

If you’re using VS Code and have Docker installed you can open the
project in a Devcontainer by pressing Ctrl+Shift+P, typing in
“Devcontainer”, and selecting “Remote-Containers: Reopen in Container”.

## Cloning and contributing

We welcome contributions!

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

``` sh
# 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:

``` sh
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
```

## Reproducing the website

To reprooduce the website, you can use the following command in R:

``` r
if (!requireNamespace("remotes", quietly = TRUE)) {
install.packages("remotes")
}
remotes::install_github("itsleeds/tds")
```

``` r
quarto::quarto_preview()
```

This is the same as running the following command in the system
terminal:

``` bash
quarto preview
```

## 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:

``` r
usethis::use_description()
usethis::use_package("stats19")
usethis::use_package("DT")
usethis::use_package("quarto")
usethis::use_package("zonebuilder")
```

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

We use the Harvard citation style, added as follows:

``` bash
wget https://github.com/citation-style-language/styles/raw/refs/heads/master/elsevier-harvard.csl
```

See documentation on Quarto website for info on publishing.