EVOLUTION-MANAGER
Edit File: cli_alert.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: CLI alerts</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <link rel="stylesheet" type="text/css" href="R.css" /> </head><body> <table width="100%" summary="page for cli_alert {cli}"><tr><td>cli_alert {cli}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2>CLI alerts</h2> <h3>Description</h3> <p>Alerts are typically short status messages. </p> <h3>Usage</h3> <pre> cli_alert(text, id = NULL, class = NULL, wrap = FALSE, .envir = parent.frame()) cli_alert_success( text, id = NULL, class = NULL, wrap = FALSE, .envir = parent.frame() ) cli_alert_danger( text, id = NULL, class = NULL, wrap = FALSE, .envir = parent.frame() ) cli_alert_warning( text, id = NULL, class = NULL, wrap = FALSE, .envir = parent.frame() ) cli_alert_info( text, id = NULL, class = NULL, wrap = FALSE, .envir = parent.frame() ) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>text</code></td> <td> <p>Text of the alert.</p> </td></tr> <tr valign="top"><td><code>id</code></td> <td> <p>Id of the alert element. Can be used in themes.</p> </td></tr> <tr valign="top"><td><code>class</code></td> <td> <p>Class of the alert element. Can be used in themes.</p> </td></tr> <tr valign="top"><td><code>wrap</code></td> <td> <p>Whether to auto-wrap the text of the alert.</p> </td></tr> <tr valign="top"><td><code>.envir</code></td> <td> <p>Environment to evaluate the glue expressions in.</p> </td></tr> </table> <h3>Details</h3> <h4>Success</h4> <div class="sourceCode r"><pre>nbld <- 11 tbld <- prettyunits::pretty_sec(5.6) cli_alert_success("Built {.emph {nbld}} status report{?s} in {tbld}.") </pre></div> <div class="asciicast" style="color: #172431;font-family: 'Fira Code',Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;line-height: 1.300000"><pre> #> <span style="color: #859900;">✔</span> Built <span style="font-style: italic;">11</span> status reports in 5.6s. </pre></div> <h4>Info</h4> <div class="sourceCode r"><pre>cfl <- "~/.cache/files/latest.cache" cli_alert_info("Updating cache file {.path {cfl}}.") </pre></div> <div class="asciicast" style="color: #172431;font-family: 'Fira Code',Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;line-height: 1.300000"><pre> #> <span style="color: #2AA198;">ℹ</span> Updating cache file <span style="color: #268BD2;">~/.cache/files/latest.cache</span>. </pre></div> <h4>Warning</h4> <div class="sourceCode r"><pre>cfl <- "~/.cache/files/latest.cache" cli_alert_warning("Failed to update cache file {.path {cfl}}.") </pre></div> <div class="asciicast" style="color: #172431;font-family: 'Fira Code',Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;line-height: 1.300000"><pre> #> <span style="color: #B58900;">!</span> Failed to update cache file <span style="color: #268BD2;">~/.cache/files/latest.cache</span>. </pre></div> <h4>Danger</h4> <div class="sourceCode r"><pre>cfl <- "~/.config/report.yaml" cli_alert_danger("Cannot validate config file at {.path {cfl}}.") </pre></div> <div class="asciicast" style="color: #172431;font-family: 'Fira Code',Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;line-height: 1.300000"><pre> #> <span style="color: #DC322F;">✖</span> Cannot validate config file at <span style="color: #268BD2;">~/.config/report.yaml</span>. </pre></div> <h4>Text wrapping</h4> <p>Alerts are printed without wrapping, unless you set <code>wrap = TRUE</code>: </p> <div class="sourceCode r"><pre>cli_alert_info("Data columns: {.val {names(mtcars)}}.") cli_alert_info("Data columns: {.val {names(mtcars)}}.", wrap = TRUE) </pre></div> <div class="asciicast" style="color: #172431;font-family: 'Fira Code',Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace;line-height: 1.300000"><pre> #> <span style="color: #2AA198;">ℹ</span> Data columns: <span style="color: #268BD2;">"mpg"</span>, <span style="color: #268BD2;">"cyl"</span>, <span style="color: #268BD2;">"disp"</span>, <span style="color: #268BD2;">"hp"</span>, <span style="color: #268BD2;">"drat"</span>, <span style="color: #268BD2;">"wt"</span>, <span style="color: #268BD2;">"qsec"</span>, <span style="color: #268BD2;">"vs"</span>, <span style="color: #268BD2;">"am"</span>, <span style="color: #268BD2;">"g</span> #> <span style="color: #268BD2;">ear"</span>, and <span style="color: #268BD2;">"carb"</span>. #> <span style="color: #2AA198;">ℹ</span> Data columns: <span style="color: #268BD2;">"mpg"</span>, <span style="color: #268BD2;">"cyl"</span>, <span style="color: #268BD2;">"disp"</span>, <span style="color: #268BD2;">"hp"</span>, <span style="color: #268BD2;">"drat"</span>, <span style="color: #268BD2;">"wt"</span>, <span style="color: #268BD2;">"qsec"</span>, #> <span style="color: #268BD2;">"vs"</span>, <span style="color: #268BD2;">"am"</span>, <span style="color: #268BD2;">"gear"</span>, and <span style="color: #268BD2;">"carb"</span>. </pre></div> <hr /><div style="text-align: center;">[Package <em>cli</em> version 3.4.1 <a href="00Index.html">Index</a>]</div> </body></html>