Day 7: roxygen2 Advanced Tags and Cross-References 📝
Master documentation with advanced roxygen2 features, with markdown-style writing! 🎯
💡 Pro Tip: Use @inheritDotParams to inherit ... parameter documentation.
📚 Resources: https://roxygen2.r-lib.org
Sorry, no caption provided by author
Advanced tags: ⚡
#' @section Warning:
#' This function modifies data in place.
#'
#' `r paste("Generated on", Sys.Date())` # Run R code
![Cross-references: 🔗
#' @seealso [other_function()], [pkg::function()]
#' @family utility functions
#' @inheritParams parent_function](https://cdn.fosstodon.org/media_attachments/files/115/677/937/504/088/418/original/6f0a3ba8626d3b0e.png)
Cross-references: 🔗
#' @seealso [other_function()], [pkg::function()]
#' @family utility functions
#' @inheritParams parent_function