Code review

[TomNash]

General Review Checklist

Purpose

• Is the purpose of the project is clear?

Pretty clearly stated, great README writeup

• Is it clear what each file in the project is intened for?

Would consider reorganizing the functions and their file location.

• It is clear how the various files interact?

Not a clear flow of how the files interact. Would have files for each set of related functions that can be sourced/loaded, then a separate driver script to use examples.

• Is it clear what the purpose if of specific sections of code?

Good variable naming, pretty clear.

• How well commented is the code on a scale of 1(no comments) to 10(very well commented).

Good commenting.

• How can the purposes of the project and files be improved?

As above, just consider reorganizing maybe.

Organization

• Is the project organized such that you can intuit where the data, scripts, and output files are stored?

Simple outputs, all data seems to be pulled off web.

• Approximately how much time did it take you to understand the work flow in the project?

Took a couple minutes, README was pretty helpful

• How well defined are code chunks in the project?

Really good spacing and readability.

• How can organization be improved?

Change how files are written, would be nice to be able to source every file. Maybe look up how to make an R package if there's just one driver function the user really needs to use. Can load all necessary packages at once, have user install dependencies on load.

Functionality

• Does the code appear to advance the purpose of the project?

Really good progress, love the plots

• Do the existing components of the project appear to function?

It definitely works well.

• How can the author improve functionality of code?

As I said, just maybe reorganize the functions within files for easier use.

Specific File Comments

Nothing specific, looks great.

[dmcglinn]

Thanks for the review @TomNash. I agree that with all these R scripts you need a road map for how they interact with one another. The README.md helps in this regard but a master script could make this clearer as @TomNash suggested. Also because there is so many dependencies I would have an R script for the user to help get those installed.