Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test- add theme and improve formatting #11

Merged
merged 1 commit into from
Jul 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions marking-criteria.qmd
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@

---
title: "Marking Criteria"
format: html
format:
html:
theme: cerulean
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we apply the them site-wide?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it makes sense to stick to one theme site-wide. This is a test at the moment. I think we can first identify the theme we like best and then apply it site-wide. There are many to choose from: https://bootswatch.com

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great plan.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Marking criteria looking good here: https://itsleeds.github.io/TDStests/marking-criteria.html

---

## Marks

Marks are awarded in 4 categories, accounting for the following criteria:

**Data processing: 20%**
### Data processing: 20%
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Much better, was going to mention this, thank you!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the quick review and approve :)


1. The selection and effective use of input datasets that are large (e.g. covering multiple years), complex (e.g. containing multiple variables) and/or diverse (e.g. input datasets from multiple sources are used and where appropriate combined in the analysis)
1. Describe how the data was collected and implications for data quality, and outline how the input datasets were downloaded (with a reproducible example if possible), with a description that will allow others to understand the structure of the inputs and how to import them
1. Evidence of data cleaning techniques (e.g. by re-categorising variables)
1. Adding value to datasets with joins (key-based or spatial), creation of new variables (also known as feature engineering) and reshaping data (e.g. from wide to long format)
2. Describe how the data was collected and implications for data quality, and outline how the input datasets were downloaded (with a reproducible example if possible), with a description that will allow others to understand the structure of the inputs and how to import them
3. Evidence of data cleaning techniques (e.g. by re-categorising variables)
4. Adding value to datasets with joins (key-based or spatial), creation of new variables (also known as feature engineering) and reshaping data (e.g. from wide to long format)

**Distinction (70%+):** The report makes use of a complex (with many columns and rows) and/or multiple input datasets, efficiently importing them and adding value by creating new variables, recategorising, changing data formats/types, and/or reshaping the data. Selected datasets are very well suited to the research questions, clearly described, with links to the source and understanding of how the datasets were generated.

Expand All @@ -23,7 +24,7 @@ Marks are awarded in 4 categories, accounting for the following criteria:

**Fail (0-49%):** The report does not make use of appropriate input datasets and contains very little or now evidence of data cleaning, adding value to the datasets or reshaping the data. While there may be some evidence of data processing, it is of poor quality and/or not appropriate for the research questions.

**Visualization and report: 20%**
### Visualization and report: 20%

1. Creation of figures that are readable and well-described (e.g. with captions and description)
1. High quality, attractive or advanced techniques (e.g. multi-layered maps or graphs, facets or other advanced techniques)
Expand All @@ -38,7 +39,7 @@ Marks are awarded in 4 categories, accounting for the following criteria:

**Fail (0-49%):** The report is of unacceptable quality (would likely be rejected in a professional setting) and/or has poor quality and/or few visualisations, or the visualisations are inappropriate given the data and research questions.

**Code quality, efficiency and reproducibility: 20%**
### Code quality, efficiency and reproducibility: 20%

1. Code quality in the submitted source code, including using consistent style, appropriate packages, and clear comments
1. Efficiency, including pre-processing to reduce input datasets (avoiding having to share large datasets in the submission for example) and computationally efficient implementations
Expand All @@ -52,7 +53,7 @@ Marks are awarded in 4 categories, accounting for the following criteria:

**Fail (0-49%):** The report has little to no reproducible, readable or efficient code. A report that includes limited well-described code in the main text or in associated files would be considered at the borderline between a fail and a pass. A report that includes no code would be considered a low fail under this criterion.

**Understanding the data science process, including choice of topic and impact: 40%**
### Understanding the data science process, including choice of topic and impact: 40%

1. Topic selection, including originality, availability of datasets related to the topic and relevance to solving transport planning problems
1. Clear research question
Expand Down