Skip to content

Update README.Rmd #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ knitr::opts_chunk$set(
[![Travis build status](https://travis-ci.org/kbodwin/flair.svg?branch=master)](https://travis-ci.org/kbodwin/flair)
<!-- badges: end -->

The goal of flair is to is to provide tools for formatting R code in knitted R Markdown files.
flair provides tools to format R code in knitted R Markdown files.

## Installation

Expand Down Expand Up @@ -257,7 +257,7 @@ ggplot(iris, aes(x = Sepal.Length,

### Evaluating code and defining objects

One nice feature the `decorate` function is that it evaluates the referenced code when it is run. This means that you can define objects in your source code, and use them later in your analysis as you normally would:
One nice feature of the `decorate` function is that it evaluates the referenced code when it is run. This means that you can define objects in your source code, and use them later in your analysis as you normally would:


```{r}
Expand All @@ -269,7 +269,7 @@ foo + 5
```


A word of caution: Make sure you define your objects in your code string, not outside the `decorate()` function! For example, the following approach has two problems:
A word of caution: Make sure you define your objects in your code string -- not outside the `decorate()` function! For example, the following approach has two problems:

1. `foo` contains the output object itself, rather than the result of the R code `mean(1:10)`, so `foo + 5` throws an error.

Expand Down