Skip to content

Latest commit

 

History

History
53 lines (40 loc) · 1.97 KB

INSTRUCTIONS.md

File metadata and controls

53 lines (40 loc) · 1.97 KB

Instructions

IMPORTANT! READ THESE INSTRUCTIONS CAREFULLY

  • It is important that you name your functions and variables as instructed, as your solutions will be auto-graded.

  • The code in your script file should be able to be run without any errors.

  • Note that not only will you be graded on the correctness of your code but also on creativity, code styling, the proper use of GitHub, as well as following instructions. Therefore, ensure that you

    • Style your code correctly--Refer to the Tidyverse Style Guide at https://style.tidyverse.org/;
    • Use comments where appropriate;
    • Cite your sources (failure to do so will result in penalties for plagiarism).

GitHub Classroom autograding and unit tests

The repo contains a folder named tests/ which contains scripts to perform unit testing of your code in solution.R. DO NOT TAMPER WITH THIS FOLDER.

During your code development, you may run the tests locally:

library(testthat)
test_dir("tests/testthat")

These tests are designed to check the conformity of your code to the instructions posted in the tasks, but not necessarily the mathematical correctness of your code. Nonetheless, the aim is to pass all the unit tests!

Marks scheme

  1. Code correctness (25 pts) w: 50%
    • Passes all unit tests
  2. Open-ended exploration (10 pts) w: 15%
    • Interesting problem
    • Substantial coding effort
    • Code runs without error
  3. Creative visualisation (10 pts) w: 15%
    • Interesting plot
    • Substantial coding effort
    • Code runs without error
  4. README (10 pts) w: 10%
    • Contains solutions to all tasks
    • Concise and informative
    • Well formatted
  5. Code styling (5 pts) w: 5%
    • Usage of tidyverse style guide
    • Readability of code
    • Organisation of code
  6. Use of GitHub (5 pts) w: 5%
    • Commit often
    • Commit messages
    • Usage of PR feedback/issues