Check out my project

[Diaz335]

@jelmerp Would you still be available Monday during office hours?

[jelmerp]

Hi Josue,

As mentioned in my email, I would happy to meet sometime soon.

Aspect	Max. points	Your points
Project organization	2	1	See below.
Project background and documentation	2	1.5
Script documentation	2	1.5
Good practices in scripts	4	2	See below.
Coding quality and complexity	3	2.5
Workflow reproducibility	3	2	See below.
Version control	3	2.5
SLURM jobs at OSC	2	2
TOTAL	20	15

Your Markdown documents are really useful to have as additional documentation; they are basically a digital lab notebook and it is good that you noted everything you did in there. However, you did not take the necessary steps to create separate executable scripts (actual .sh and .py files that can be directly run from the command-line) + a workflow script that can directly rerun the project.

Moreover, your Markdown documents, as rendered on GitHub, are very hard to read. For instance, the code is not put in code blocks, and line breaks are not properly displayed.

• Good practices in scripts

  • You did not add actual scripts to your repo.
  • You should have written a loop to run structure.py for different values of K.

• Project organization

  • Everything is in a single dir.
  • There are no actual scripts, just Markdown documents that contain lots of different things including code for scripts.

• Workflow reproducibility

  • The project is somewhat rerunnable by following the instructions in your Markdown files, but the idea was that you had an actual script (e.g. a shell script or Snakefile) that can be run.