R/package_iarccrgtools.R

In WetRobot/iarccrgtools: IARC CRG Tools Utilities

#' @title `iarccrgtools`
#' @name iarccrgtools
#' @docType package
#' @title Package `iarccrgtools`
#' @eval c(
#'   codedoc::codedoc_R_package_description("iarccrgtools"),
#'   codedoc::codedoc_news_for_R_package()
#' )
NULL

# @codedoc_comment_block R_package_description(iarccrgtools)
# Utilities for using IARC CRG Tools on Windows via R.
#
# <!-- badges: start -->
# [![R-CMD-check](https://github.com/WetRobot/iarccrgtools/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/WetRobot/iarccrgtools/actions/workflows/R-CMD-check.yaml)
# <!-- badges: end -->
#
# # Recommended installation
#
# ```r
# devtools::install_github(
#   "FinnishCancerRegistry/iarccrgtools",
#   ref = readline("enter latest tag on github: ")
# )
# ```
#
# # Example
# ```r
# @codedoc_insert_comment_block R_package_example(iarccrgtools)
# ```
#
# @codedoc_comment_block R_package_description(iarccrgtools)