Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jpmonteagudo28/wordsmith

In writing, keep it DRY (Don't Repeat Yourself). An R package to determine which words to use in your writing.
https://github.com/jpmonteagudo28/wordsmith

Last synced: about 1 month ago
JSON representation

In writing, keep it DRY (Don't Repeat Yourself). An R package to determine which words to use in your writing.

Awesome Lists containing this project

README

        

---
output: github_document
---

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

# wordsmith wordsmith package

[![stability-wip](https://img.shields.io/badge/stability-wip-lightgrey.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#work-in-progress)
[![CRAN
status](https://www.r-pkg.org/badges/version/wordsmith)](https://CRAN.R-project.org/package=wordsmith)

The goal of wordsmith is to ...

## Installation

You can install the development version of wordsmith from [GitHub](https://github.com/) with:

``` r
# install.packages("pak")
pak::pak("jpmonteagudo28/wordsmith")
```

## Example

This is a basic example which shows you how to solve a common problem:

```{r example}
# library(wordsmith)
## basic example code
```

What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:

```{r cars}
summary(cars)
```

You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this.

In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.