Skip to content

A few edits to the README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ecknight wants to merge 3 commits into
base: main
Choose a base branch
from
Open

A few edits to the README #1

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8472156
Add sections note
ecknight Oct 3, 2024
e66029f
Add note about proposed improvements to code
ecknight Oct 3, 2024
87156c2
Change wording
ecknight Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Scripts should start with a header that includes the following components:
| **Date** | The creation or last modification date of the code, formatted as YYYY-MM-DD for consistency. |
| **Inputs** | A list of the input data, files, or parameters required for the script to run, including file paths or formats. |
| **Outputs** | A description of the output produced by the script, including file names, formats, and what the results represent. |
| **Notes** | A concise explanation of what the code does, its purpose, and any important details about its function. |
| **Notes** | A concise explanation of what the code does, its purpose, and any important details about its function. You can also use this section to list proposed improvements for the code for future iterations. |


**Example header in YAML-like format:**
Expand Down Expand Up @@ -173,6 +173,8 @@ Subdivide sections as needed with descriptive numbered subheadings:
filtered_data <- data %>% filter(variable == "value")
```

Use four trailing dashes (-), equal signs (=), or hashtags (#) at the end of your headings to create discrete sections that are foldable and navigable within RStudio's **Jump To** menu at the bottom of the editor.

---

## 3. Documenting Functions
Expand Down