Include release notes for a package, either the release notes for the most recent package release or release notes matching a search term.
Value
Returns the release notes for the currently installed version of the package, or the release notes matching the search term.
See also
Other Tools:
btw_tool_env_describe_data_frame(),
btw_tool_env_describe_environment(),
btw_tool_files_list_files(),
btw_tool_files_read_text_file(),
btw_tool_files_write_text_file(),
btw_tool_ide_read_current_editor(),
btw_tool_package_docs,
btw_tool_search_packages(),
btw_tool_session_package_info(),
btw_tool_session_platform_info(),
btw_tool_web_read_url(),
btw_tools()
Examples
# Copy release notes to the clipboard for use in any AI app
btw("@news dplyr", clipboard = FALSE)
#> ## Context
#>
#> ### dplyr v1.1.4
#>
#> - `join_by()` now allows its helper functions to be namespaced with
#> `dplyr::`, like `join_by(dplyr::between(x, lower, upper))` (#6838).
#>
#> - `left_join()` and friends now return a specialized error message if
#> they detect that your join would return more rows than dplyr can
#> handle (#6912).
#>
#> - `slice_*()` now throw the correct error if you forget to name `n`
#> while also prefixing the call with `dplyr::` (#6946).
#>
#> - `dplyr_reconstruct()`\'s default method has been rewritten to avoid
#> materializing duckplyr queries too early (#6947).
#>
#> - Updated the `storms` data to include 2022 data (#6937, \@steveharoz).
#>
#> - Updated the `starwars` data to use a new API, because the old one is
#> defunct. There are very minor changes to the data itself (#6938,
#> \@steveharoz).
btw("@news dplyr join_by", clipboard = FALSE)
#> ## Context
#>
#> ### dplyr v1.1.4
#>
#> `join_by()` now allows its helper functions to be namespaced with
#> `dplyr::`, like `join_by(dplyr::between(x, lower, upper))` (#6838).
#>
#> ### dplyr v1.1.0
#>
#> #### New features
#>
#> Joins have been completely overhauled to enable more flexible join
#> operations and provide more tools for quality control. Many of these
#> changes are inspired by data.table\'s join syntax (#5914, #5661, #5413,
#> #2240).
#>
#> - A *join specification* can now be created through `join_by()`. This
#> allows you to specify both the left and right hand side of a join
#> using unquoted column names, such as
#> `join_by(sale_date == commercial_date)`. Join specifications can be
#> supplied to any `*_join()` function as the `by` argument.
#>
#> - Join specifications allow for new types of joins:
#>
#> - Equality joins: The most common join, specified by `==`. For
#> example, `join_by(sale_date == commercial_date)`.
#>
#> - Inequality joins: For joining on inequalities, i.e.`>=`, `>`, `<`,
#> and `<=`. For example, use `join_by(sale_date >= commercial_date)`
#> to find every commercial that aired before a particular sale.
#>
#> - Rolling joins: For \"rolling\" the closest match forward or
#> backwards when there isn\'t an exact match, specified by using the
#> rolling helper, `closest()`. For example,
#> `join_by(closest(sale_date >= commercial_date))` to find only the
#> most recent commercial that aired before a particular sale.
#>
#> - Overlap joins: For detecting overlaps between sets of columns,
#> specified by using one of the overlap helpers: `between()`,
#> `within()`, or `overlaps()`. For example, use
#> `join_by(between(commercial_date, sale_date_lower, sale_date))` to
#> find commercials that aired before a particular sale, as long as
#> they occurred after some lower bound, such as 40 days before the
#> sale was made.
#>
#> Note that you cannot use arbitrary expressions in the join conditions,
#> like `join_by(sale_date - 40 >= commercial_date)`. Instead, use
#> `mutate()` to create a new column containing the result of
#> `sale_date - 40` and refer to that by name in `join_by()`.
#>
#> - `multiple` is a new argument for controlling what happens when a row
#> in `x` matches multiple rows in `y`. For equality joins and rolling
#> joins, where this is usually surprising, this defaults to signalling a
#> `"warning"`, but still returns all of the matches. For inequality
#> joins, where multiple matches are usually expected, this defaults to
#> returning `"all"` of the matches. You can also return only the
#> `"first"` or `"last"` match, `"any"` of the matches, or you can
#> `"error"`.
#>
#> - `keep` now defaults to `NULL` rather than `FALSE`. `NULL` implies
#> `keep = FALSE` for equality conditions, but `keep = TRUE` for
#> inequality conditions, since you generally want to preserve both sides
#> of an inequality join.
#>
#> - `unmatched` is a new argument for controlling what happens when a row
#> would be dropped because it doesn\'t have a match. For backwards
#> compatibility, the default is `"drop"`, but you can also choose to
#> `"error"` if dropped rows would be surprising.
if (R.version$major == 4 && R.version$minor > "2.0") {
# Should find a NEWS entry from R 4.2
btw("@news R dynamic rd content", clipboard = FALSE)
}
#> ## Context
#>
#> ### R v4.2.0
#>
#> #### UTILITIES
#>
#> For packages using the `\doi`{style="white-space: pre;"} Rd macro (now
#> an install-time `\Sexpr`{style="white-space: pre;"}) but no other
#> dynamic Rd content, `R CMD build` now produces a smaller tarball and is
#> considerably faster -- skipping temporary package installation.
# Tool use by LLMs via ellmer or MCP ----
btw_tool_docs_package_news("dplyr")
#> <btw::BtwPackageNewsToolResult>
#> @ value : chr "### dplyr v1.1.4\n\n- `join_by()` now allows its helper functions to be namespaced with\n `dplyr::`, like `joi"| __truncated__
#> @ error : NULL
#> @ extra : list()
#> @ request: NULL
btw_tool_docs_package_news("dplyr", "join_by")
#> <btw::BtwPackageNewsToolResult>
#> @ value : chr "### dplyr v1.1.4\n\n`join_by()` now allows its helper functions to be namespaced with\n`dplyr::`, like `join_by"| __truncated__
#> @ error : NULL
#> @ extra : list()
#> @ request: NULL