These functions describe package documentation in plain text.
Usage
btw_tool_docs_package_help_topics(package_name)
btw_tool_docs_help_page(topic, package_name = "")
btw_tool_docs_available_vignettes(package_name)
btw_tool_docs_vignette(package_name, vignette = package_name)Arguments
- package_name
The name of the package as a string, e.g.
"shiny".- topic
The
topic_idoraliasof the help page, e.g."withProgress"or"incProgress". Findtopic_ids oraliases usingget_package_help().- vignette
The name (or index) of the vignette to retrieve. Defaults to the "intro" vignette to the package (by the same rules as pkgdown.)
Value
btw_tool_docs_package_help_topics()returns thetopic_id,title, andaliasesfields for every topic in a package's documentation as a json-formatted string.btw_tool_docs_help_page()returns the help-page for a package topic as a string.
See also
Other Tools:
btw_tool_docs_package_news(),
btw_tool_env_describe_data_frame(),
btw_tool_env_describe_environment(),
btw_tool_files_list_files(),
btw_tool_files_read_text_file(),
btw_tool_ide_read_current_editor(),
btw_tool_search_packages(),
btw_tool_session_package_info(),
btw_tool_session_platform_info(),
btw_tools()
Examples
btw_tool_docs_package_help_topics("btw")
#> <btw::BtwToolResult>
#> @ value : chr [1:3] "```json" ...
#> @ error : NULL
#> @ extra :List of 1
#> .. $ data: tibble [20 × 3] (S3: tbl_df/tbl/data.frame)
#> .. ..$ topic_id: chr [1:20] "btw" "btw-package" "btw_client" "btw_this" ...
#> .. ..$ title : chr [1:20] "Plain-text descriptions of R objects" "btw: Describe R Stuff to Large Language Models" "Create a btw-enhanced ellmer chat client" "Describe something for use by an LLM" ...
#> .. ..$ aliases :List of 20
#> .. .. ..$ : 'AsIs' chr "btw"
#> .. .. ..$ : 'AsIs' chr "btw-package"
#> .. .. ..$ : 'AsIs' chr [1:2] "btw_client" "btw_app"
#> .. .. ..$ : 'AsIs' chr "btw_this"
#> .. .. ..$ : 'AsIs' chr "btw_this.character"
#> .. .. ..$ : 'AsIs' chr [1:2] "btw_this.data.frame" "btw_this.tbl"
#> .. .. ..$ : 'AsIs' chr "btw_this.environment"
#> .. .. ..$ : 'AsIs' chr "btw_tool_docs_package_news"
#> .. .. ..$ : 'AsIs' chr "btw_tool_env_describe_data_frame"
#> .. .. ..$ : 'AsIs' chr "btw_tool_env_describe_environment"
#> .. .. ..$ : 'AsIs' chr "btw_tool_files_list_files"
#> .. .. ..$ : 'AsIs' chr "btw_tool_files_read_text_file"
#> .. .. ..$ : 'AsIs' chr "btw_tool_ide_read_current_editor"
#> .. .. ..$ : 'AsIs' chr [1:5] "btw_tool_package_docs" "btw_tool_docs_package_help_topics" "btw_tool_docs_help_page" "btw_tool_docs_available_vignettes" ...
#> .. .. ..$ : 'AsIs' chr "btw_tool_search_package_info"
#> .. .. ..$ : 'AsIs' chr "btw_tool_search_packages"
#> .. .. ..$ : 'AsIs' chr "btw_tool_session_check_package_installed"
#> .. .. ..$ : 'AsIs' chr "btw_tool_session_package_info"
#> .. .. ..$ : 'AsIs' chr "btw_tool_session_platform_info"
#> .. .. ..$ : 'AsIs' chr "btw_tools"
#> @ request: NULL
btw_tool_docs_help_page("btw", "btw")
#> <btw::BtwHelpPageToolResult>
#> @ value : chr [1:76] "## `help(package = \"btw\", \"btw\")`" "" ...
#> @ error : NULL
#> @ extra :List of 3
#> .. $ help_text: chr [1:75] "" "### Plain-text descriptions of R objects" "" "#### Description" ...
#> .. $ topic : chr "btw"
#> .. $ package : chr "btw"
#> @ request: NULL
# show the TOC of vignettes in the dplyr package
btw_tool_docs_available_vignettes("dplyr")
#> <btw::BtwToolResult>
#> @ value : chr [1:11] "[" ...
#> @ error : NULL
#> @ extra :List of 1
#> .. $ data:'data.frame': 9 obs. of 2 variables:
#> .. ..$ vignette: chr [1:9] "colwise" "grouping" "dplyr" "programming" ...
#> .. ..$ title : chr [1:9] "Column-wise operations" "Grouped data" "Introduction to dplyr" "Programming with dplyr" ...
#> @ request: NULL
# returns a whole bunch of output and relies on
# dplyr to have the mentioned vignettes available
if (FALSE) { # \dontrun{
# grab the intro vignette
btw_tool_docs_vignette("dplyr")
# grab the programming vignette specifically
btw_tool_docs_vignette("dplyr", "programming")
} # }