Skip to content

roxygen2 7.1.0
Compare
Choose a tag to compare
@hadley hadley released this 11 Mar 18:44
v7.1.0
d691381

New features

  • roxygen2 now supports inline markdown code and also code chunks,
    using the same notation as the knitr package. For example:

    #' This manual was generated at: `r Sys.time()`. 
#' ... 
#' `mtcars` is a data frame with `r ncol(mtcars)` columns, here 
#' is a summary of them: 
#' 
#' ```{r} 
#' summary(mtcars) 
#' ```

    See vignette("rd-formatting") for details.

  • roxygen2 now keeps using Windows (CR LF) line endings for files that
    already have CR LF line endings, and uses LF for new files (#989).

Minor improvements and bug fixes

  • Auto-generated package documentation can now handle author ORCID comments
    containing full url (#1040).

  • Hyperlinks to R6 methods are also added in the PDF manual (#1006).

  • Empty annotations (alternate text) for figures added via markdown are now
    omitted. This caused issues when generating pkgdown web sites (#1051).

  • Roxygen metadata can now have a packages element, giving a character vector
    of package names to load. This makes it easier to use extension package that
    provide new tags for existing roclets (#1013). See ?load_options for
    more details.

    Roxygen: list(markdown = TRUE, packages = "roxygenlabs")

  • @evalNamespace() works again (#1022).

  • @description NULL and @details NULL no longer fail; instead, these tags
    are ignored, except for @description NULL in package level documentation,
    where it can be used to suppress the auto-generated Description section
    (#1008).

  • Multiple @format tags are now combined (#1015).

  • The warning for @section titles spanning multiple lines now includes a
    hint that you're missing a colon (@maelle, #994).

  • Can now document objects created with delayedAssign() by forcing
    evaluation at documentation time (#1041)

Assets 2
Loading