In Paul-inio/fndwords: What the Package Does (One Line, Title Case)

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

fndwords

The goal of fndwords is to help you with resolving a crossword.

Installation

You can install the development version of fndwords from GitHub with:

# install.packages("devtools")
devtools::install_github("spacea/projekt-2022-wieland")

Example

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

library(fndwords)
## find_words("v..y", c("nice", "very", "small", "package", "bro"), report = TRUE)

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

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. You could also use GitHub Actions to re-render README.Rmd every time you push. An example workflow can be found here: https://github.com/r-lib/actions/tree/v1/examples.

You can also embed plots, for example:

plot(pressure)

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

Paul-inio/fndwords documentation built on April 8, 2022, 12:34 a.m.