Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR transforms the README from a development-focused document to a user-friendly package documentation. The changes include restructuring content to follow standard R package README conventions, removing detailed internal development notes, and adding clear usage examples and feature descriptions.
Key Changes:
- Restructured content with standard sections (Installation, Overview, Features, Quick Start)
- Removed detailed development roadmap and internal workflow documentation
- Added user-focused feature descriptions and usage examples
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| Example data and templates are available in the `resources/` folder: - | ||
| `hesper_key.xlsx` - `template_tool_hh.xlsx` - | ||
| `template_tool_individual_level.xlsx` |
There was a problem hiding this comment.
The list formatting is incorrect. Remove the dash after the colon and use proper bullet points on separate lines.
| Example data and templates are available in the `resources/` folder: - | |
| `hesper_key.xlsx` - `template_tool_hh.xlsx` - | |
| `template_tool_individual_level.xlsx` | |
| Example data and templates are available in the `resources/` folder: | |
| - `hesper_key.xlsx` | |
| - `template_tool_hh.xlsx` | |
| - `template_tool_individual_level.xlsx` |
| - ☐ Composition of needed columns | ||
| - ☐ Data cleaning | ||
| - ☐ Analyses and visualization | ||
| - ☐ Publication (reports, presentations) |
There was a problem hiding this comment.
Use standard markdown checkboxes - [ ] instead of Unicode checkbox symbols ☐ for better compatibility across different markdown renderers.
| - ☐ Composition of needed columns | |
| - ☐ Data cleaning | |
| - ☐ Analyses and visualization | |
| - ☐ Publication (reports, presentations) | |
| - [ ] Composition of needed columns | |
| - [ ] Data cleaning | |
| - [ ] Analyses and visualization | |
| - [ ] Publication (reports, presentations) |
No description provided.