https://github.com/finnishcancerregistry/codedoc

Keep your documentation close to your code --- with extractable comments.
https://github.com/finnishcancerregistry/codedoc

automated-documentation code-comments code-documentation developer-tools documentation documentation-generation documentation-tool r r-package r-tools software-documentation

Last synced: 9 months ago
JSON representation

Keep your documentation close to your code --- with extractable comments.

• Host: GitHub
• URL: https://github.com/finnishcancerregistry/codedoc
• Owner: FinnishCancerRegistry
• License: other
• Created: 2020-10-23T09:39:28.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2025-03-14T09:51:53.000Z (10 months ago)
• Last Synced: 2025-03-14T10:36:36.157Z (10 months ago)
• Topics: automated-documentation, code-comments, code-documentation, developer-tools, documentation, documentation-generation, documentation-tool, r, r-package, r-tools, software-documentation
• Language: R
• Homepage:
• Size: 176 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# Package `codedoc`

Allows generation of documentation from specifically

formatted code comments.

[![R-CMD-check](https://github.com/FinnishCancerRegistry/codedoc/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/FinnishCancerRegistry/codedoc/actions/workflows/R-CMD-check.yaml)

# Recommended installation

```r

devtools::install_github(

  "FinnishCancerRegistry/codedoc",

  ref = readline("enter latest tag on github: ")

)

```

# Example

```r

block_df <- codedoc::extract_keyed_comment_blocks(

  text_file_paths = codedoc::example_text_file_path("r_script.R")

)

print(block_df)

```