README.md

Package codedoc

Allows generation of documentation from specifically formatted code comments.

Recommended installation

devtools::install_github(
  "FinnishCancerRegistry/codedoc",
  ref = readline("enter latest tag on github: ")
)

Example

block_df <- codedoc::extract_keyed_comment_blocks(
  text_file_paths = codedoc::example_text_file_path("r_script.R")
)
print(block_df)