-
Notifications
You must be signed in to change notification settings - Fork 48
/
Copy pathREADME.qmd
91 lines (65 loc) · 2.94 KB
/
README.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
---
format: gfm
---
[](https://github.com/itsleeds/tds/actions/workflows/pages/pages-build-deployment)
[](https://github.com/codespaces/new/itsleeds/tds?quickstart=1)
[](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.
## 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.
<!-- Note: we have branch protections in place so you should create a PR before pushing to the main branch. -->
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
```
## Archive
See an archived version of the repo, before we switched to using Quarto, at https://github.com/itsleeds/tdsarchive
## Setup
<details>
To set it up we used commands such as:
```{r}
#| eval: false
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:
```{bash}
#| eval: false
#| echo: false
cd docs/slides
docker run --rm -t -v .:/slides astefanutti/decktape -s 1280x720 generic https://itsleeds.github.io/tds/slides/intro.html intro.pdf
firefox intro.pdf
```
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.