https://github.com/bradyajohnston/alchemist

What the Package Does (One Line, Title Case)
https://github.com/bradyajohnston/alchemist

Last synced: 12 days ago
JSON representation

What the Package Does (One Line, Title Case)

• Host: GitHub
• URL: https://github.com/bradyajohnston/alchemist
• Owner: BradyAJohnston
• License: other
• Created: 2023-03-20T07:15:31.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-03-20T07:17:28.000Z (over 1 year ago)
• Last Synced: 2024-10-07T09:21:19.374Z (about 1 month ago)
• Language: R
• Homepage: https://bradyajohnston.github.io/alchemist/
• Size: 2.93 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

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%"

)

```

# alchemist

[![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/alchemist)](https://CRAN.R-project.org/package=alchemist)

The goal of alchemist is to ...

## Installation

You can install the development version of alchemist like so:

``` r

# FILL THIS IN! HOW CAN PEOPLE INSTALL YOUR DEV PACKAGE?

```

## Example

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

```{r example}

library(alchemist)

## 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. You could also use GitHub Actions to re-render `README.Rmd` every time you push. An example workflow can be found here: .

You can also embed plots, for example:

```{r pressure, echo = FALSE}

plot(pressure)

```

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