Zhen - code review - Githubissues

File Management

Are all code and data files organized into appropriate folders?

[ ] Always
[ ] Sometimes
[ ] Never

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

[ ] Always
[ ] Sometimes
[ ] Never

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

Are all data frames and functions commented with sufficient detail?

[ ] Always
[ ] Sometimes
[ ] Never

Efficiency

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

[ ] Always
[ ] Sometimes
[ ] Never

Are functions implemented to avoid repeating lines of code?

[ ] Always
[ ] Sometimes
[ ] Never

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

Style

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

[ ] Always
[ ] Sometimes
[ ] Never

Do all variable and function names accurately describe their content?

[ ] Always
[ ] Sometimes
[ ] Never

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

[ ] Always
[ ] Sometimes
[ ] Never

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

[ ] Always
[ ] Sometimes
[ ] Never

Message random

Dance-Data-Project / smith-capstone-23

Zhen - code review #46

File Management

Are all code and data files organized into appropriate folders?

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

Commenting

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

Are all data frames and functions commented with sufficient detail?

Efficiency

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

Are functions implemented to avoid repeating lines of code?

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

Style

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

Do all variable and function names accurately describe their content?

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

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