{"id":17153873,"url":"https://github.com/stevenmmortimer/sectioncomment","last_synced_at":"2025-03-24T13:20:26.125Z","repository":{"id":95730494,"uuid":"76005469","full_name":"StevenMMortimer/sectioncomment","owner":"StevenMMortimer","description":"RStudio Addin to Create Section Comments","archived":false,"fork":false,"pushed_at":"2016-12-09T19:08:56.000Z","size":10136,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-29T18:22:14.720Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/StevenMMortimer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-12-09T05:43:22.000Z","updated_at":"2016-12-09T05:44:08.000Z","dependencies_parsed_at":"2023-05-21T19:45:22.618Z","dependency_job_id":null,"html_url":"https://github.com/StevenMMortimer/sectioncomment","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StevenMMortimer%2Fsectioncomment","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StevenMMortimer%2Fsectioncomment/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StevenMMortimer%2Fsectioncomment/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StevenMMortimer%2Fsectioncomment/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StevenMMortimer","download_url":"https://codeload.github.com/StevenMMortimer/sectioncomment/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245276093,"owners_count":20588895,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-14T21:47:33.790Z","updated_at":"2025-03-24T13:20:26.089Z","avatar_url":"https://github.com/StevenMMortimer.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sectioncomment\n\nCreates an 80 character width comment right-padded with hyphens, similar to how \ncomments are recommended in Hadley's style guide (http://adv-r.had.co.nz/Style.html) which \nrecommends: \"Use commented lines of - and = to break up your file into easily readable chunks.\"\n\n```r\n# Load data ---------------------------\n# Plot data ---------------------------\n```\n\nThe additional benefit is that comments formatted in this manner appear in the selection box \nat the bottom left of the Source Pane for easier navigation.\n\n![Source Pane Navigator](internal/example-section-break.png)\n\n## System Requirements\n\n* Run RStudio v0.99.878 or later\n  - \u003chttps://www.rstudio.com/products/rstudio/download/preview/\u003e\n* Run `rstudioapi` package v0.5 or later\n  - `install.packages(\"rstudioapi\", type = \"source\")`\n* Populate your *Addins* dropdown menus with some examples\n  - `devtools::install_github(\"rstudio/addinexamples\", type = \"source\")`\n\n## Installation\n\n```r\ndevtools::install_github(\"ReportMort/sectioncomment\")\n```\n\n## Usage\n\n#### Change Existing Commment to Section Comment\n\nUseful to convert your existing comments into sections \nin order to help with code readability\n\n![](internal/existing_comment.gif)\n\n\n#### Select Text and Convert all Comments to Section Comments\n\nIf you select a multiple lines of text then all comments \nwithin the selection will be converted to section comments \nafter clicking `Addins \u003e Section Comment`\n\n![](internal/comment_selection.gif)\n\n\n#### Create a New Comment as a Section Comment\n\nUseful when you just want to add placeholder section\ncomments to come back and fill in later\n\n![](internal/add_new.gif)\n\n\n#### Scan Entire Document for Comments to Convert \n\nIf you put the cursor at Line 1, Column 1 or hit `CTRL+A` before \nclicking `Addins \u003e Section Comment`, then all comments prefixed \nwith 2 or more hashes will be converted to Section Comments\n\n![](internal/convert_all.gif)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstevenmmortimer%2Fsectioncomment","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstevenmmortimer%2Fsectioncomment","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstevenmmortimer%2Fsectioncomment/lists"}