Skip to content

roxygen2 7.2.1
Compare
Choose a tag to compare
@hadley hadley released this 18 Jul 16:40
v7.2.1
f0f6c77

Tags

  • All built-in tags are now documented so that you can do (e.g.) ?"@param"
    to get a basic description of @param and a pointer where to learn more
    (#1165). This is powered by a new tags_list() lists all tags defined by
    roxygen2 and tags_metadata() provides some useful information about them
    for use by (e.g.) IDEs (#1375).

  • @describeIn can now be used to combine more types of functions
    (generics, methods and other functions) into a single topic.
    The resulting section organises the functions by type (#1181)
    and displays methods like function calls. Methods are recognized only if
    they extend the generic in the destination,or if the destination can
    heuristically be identified as a constructor.

  • Code evaluated in inline markdown code chunks and @eval/@evalRd/
    @evalNamespace is now evaluated in an environment designed to be more
    reproducible and to suppress output that won't work in Rd (e.g. turning
    off colour and unicode support in cli) (#1351). They now also set
    knitr options comment = #> (#1380) and collapse = TRUE (#1376).

  • @export will now export both the class and constructor function when
    applied to expressions like foo <- setClass("foo") (#1216).

  • @includeRmd now gives better feedback when it fails (#1089).

(R)markdown

  • New knitr_chunk_options option (in the Roxygen entry of
    DESCRIPTION or in man/roxygen/meta.R) is added to the knitr chunk
    options that roxygen2 uses for markdown code blocks and inline
    code (#1390).

  • PDF figures are only included the PDF manual, and SVG figures are only
    included in the HTML manual (#1399).

  • You can now use alternative knitr engines in markdown code blocks (#1149).

  • Generated HTML for code blocks never includes "NA" for language (#1251).

  • Using a level 1 heading in the wrong tag now gives a more useful warning
    (#1374).

  • Fix bug interpolating the results of indented inline RMarkdown (#1353).

Other

  • If you have a daily build of RStudio, the lists of changed Rd files are
    now clickable so you can immediately see the rendered development
    documentation (#1354).

  • R6 documentation no longer shows inherited methods if there aren't any
    (#1371), and only links to superclass docs if they're actually available
    (#1236).

  • Automated usage no longer mangles nbsp in default arguments (#1342).

Assets 2