README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# echo

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
<!-- [![CRAN status](https://www.r-pkg.org/badges/version/echo)](https://CRAN.R-project.org/package=echo) -->
[![R-CMD-check](https://github.com/jmbarbone/echo/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jmbarbone/echo/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/jmbarbone/echo/branch/main/graph/badge.svg)](https://app.codecov.io/gh/jmbarbone/echo?branch=main)
<!-- badges: end -->

The goal of `{echo}` is to provide a function for evaluating and logging a script.

## Installation

Install `{echo}` from CRAN with:

``` r
install.packages("echo")
```

Alternatively, you can install the development version of `{echo}` [GitHub](https://github.com/) with:

```
# install.packages("devtools")
devtools::install_github("jmbarbone/echo")
```

## Example

`echo()` allows you to print 

```{r example}
library(echo)
try(echo(
  expr = {
    print(1 + 1)
    df <- data.frame(a = 1:5, b = letters[1:5])
    print(df)
    message("hello!")
    warning("hello!")
    stop("error here")
  },
  level = 0
), silent = TRUE)
```