From a254da4a37cc1699b3e15cd52876cfc227cde853 Mon Sep 17 00:00:00 2001 From: Richard Iannone Date: Fri, 14 Jun 2024 11:16:12 -0400 Subject: [PATCH] Create info_unit_conversions.Rd --- man/info_unit_conversions.Rd | 55 ++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 man/info_unit_conversions.Rd diff --git a/man/info_unit_conversions.Rd b/man/info_unit_conversions.Rd new file mode 100644 index 0000000000..c2f3c4a84e --- /dev/null +++ b/man/info_unit_conversions.Rd @@ -0,0 +1,55 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/info_tables.R +\name{info_unit_conversions} +\alias{info_unit_conversions} +\title{View a table with all units that can be converted by \code{unit_conversion()}} +\usage{ +info_unit_conversions() +} +\value{ +An object of class \code{gt_tbl}. +} +\description{ +\code{\link[=unit_conversion]{unit_conversion()}} can be used to yield conversion factors across compatible +pairs of units. This is useful for expressing values in different units and +the conversion can be performed via the \code{scale_by} argument available in +several formatting functions. When calling \code{\link[=unit_conversion]{unit_conversion()}}, one must +supply two string-based keywords to specify the value's current units and the +desired units. All of these keywords are provided in the table shown by +calling \code{info_unit_conversions()}. +} +\section{Examples}{ + + +Get a table of info on all the available keywords for unit conversions. + +\if{html}{\out{
}}\preformatted{info_unit_conversions() +}\if{html}{\out{
}} + +\if{html}{\out{ +This image of a table was generated from the first code example in the `info_unit_conversions()` help file. +}} +} + +\section{Function ID}{ + +11-9 +} + +\section{Function Introduced}{ + +\emph{In Development} +} + +\seealso{ +Other information functions: +\code{\link{info_currencies}()}, +\code{\link{info_date_style}()}, +\code{\link{info_flags}()}, +\code{\link{info_google_fonts}()}, +\code{\link{info_icons}()}, +\code{\link{info_locales}()}, +\code{\link{info_paletteer}()}, +\code{\link{info_time_style}()} +} +\concept{information functions}