Style is an important element of writing useful scripts for statistical computing. Scripts submitted for this course will be graded using the rubric below. The rubric consists of five key elements: headers, comments, formatting, naming, and consistency. Each element will be graded according to the three point scale provided below.
| Score | Description |
|---|---|
| 2 | Scripts for this assignment are excellent demonstrations of the graded style element. |
| 1 | Scripts for this assignment generally follow the graded style element but show occasional lapses in consistency or minor deviations from the guideline. Lapses or inconsistencies impact the aesthetic appeal of the script, but not its overall readability. |
| 0 | Scripts for this assignment show significant lapses or omissions in the style element and impact the overall readability of the script. |
Scripts will be scored on each of the key style elements below.
| Style Element | Description |
|---|---|
| Header | The script contains an informative and clearly demarcated header including these essential elements: short title, author, references to sources for data or approach, relation (if any) to other project scripts, and a concise description of what the script does. |
| Comments | Comments are used appropriately throughout the script to organize the script and clarify how particular chunks of code relate to the whole. |
| Formatting | Indentation and spacing are used consistently to maximize readability. Long lines are broken into appropriate pieces (max 80 characters). Indentation and spacing conventions are followed. |
| Naming | Variables, functions, and other objects are named appropriately and add to each script’s readability. Capitalization and word separators are used consistently and follow course style. |
| Consistency | Stylistic choices are used consistently throughout each script and follow commonly used conventions or agreed upon norms. |