From 8472156369fd81c2610930c9dab2f9b1b81aa7c3 Mon Sep 17 00:00:00 2001 From: ecknight Date: Thu, 3 Oct 2024 15:06:24 -0600 Subject: [PATCH 1/3] Add sections note --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 4837663..d2a89d7 100644 --- a/README.md +++ b/README.md @@ -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 From e66029f023d64e462f34b6c585188d98205775f0 Mon Sep 17 00:00:00 2001 From: ecknight Date: Thu, 3 Oct 2024 15:10:00 -0600 Subject: [PATCH 2/3] Add note about proposed improvements to code --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d2a89d7..0d856ee 100644 --- a/README.md +++ b/README.md @@ -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 future proposed improvements for the code. | **Example header in YAML-like format:** From 87156c2543139463ef3ce7908af91191fd897d9a Mon Sep 17 00:00:00 2001 From: ecknight Date: Thu, 3 Oct 2024 15:10:27 -0600 Subject: [PATCH 3/3] Change wording --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0d856ee..2f95f6a 100644 --- a/README.md +++ b/README.md @@ -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. You can also use this section to list future proposed improvements for the code. | +| **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:**