File Management

Are all code and data files organized into appropriate folders?

• Always
• Sometimes
• Never

Comments:

Do all file names in the repository (including .Rmd, .csv, .md) accurately describe the content of the file?

• Always
• Sometimes
• Never

Comments:

Commenting

Are all code chunks or distinctive code sections commented with enough detail such that an external reviewer can interpret their purpose?

• Always
• Sometimes
• Never

Comments:

Are all data frames and functions commented with sufficient detail?

• Always
• Sometimes
• Never

Comments:

Efficiency

Is at least one function from each imported package referenced in the code?

• Always
• Sometimes
• Never

Comments:

Are functions implemented to avoid repeating lines of code?

• Always
• Sometimes
• Never

Comments:

Does each section of the code have a distinctive purpose? (In other words, could you devise a meaningful "table of contents" for your code?)

• Always
• Sometimes
• Never

Comments:

Style

Does the code adhere to the conventions outlined in the team's style guide?

• Always
• Sometimes
• Never

Comments:

Do all variable and function names accurately describe their content?

• Always
• Sometimes
• Never

Comments:

Are new lines used effectively such that code can be read without having to scroll across the screen?

• Always
• Sometimes
• Never

Comments:

Have all unused lines of code been removed from the file?

• Always
• Sometimes
• Never

Comments:

@m-sezgin can you send a PR with your data documentation to this repo?

Looks like plate_type could loosely align with these, but we are unsure.

Unsure what this means

bad_locations <- boston_pd_1120 |>
  group_by(citation_number) |>
  summarize(
    num_offenses = n(),
    locations = n_distinct(location_name)
  ) |>
  filter(locations > 1)

Things to check:

• missing or inconsistent locations
• missing or inconsistent races
• missing or inconsistent officer_id
• missing citation number
• missing or inconsistent dates