https://github.com/thisisnic/factotum

https://github.com/thisisnic/factotum

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/thisisnic/factotum
• Owner: thisisnic
• License: other
• Created: 2021-08-10T08:58:19.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-08-18T10:23:18.000Z (over 3 years ago)
• Last Synced: 2024-12-03T18:52:11.589Z (about 2 months ago)
• Language: R
• Size: 27.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

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

)

```

# factotum

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

[![Codecov test coverage](https://codecov.io/gh/thisisnic/factotum/branch/main/graph/badge.svg)](https://codecov.io/gh/thisisnic/factotum?branch=main)

The goal of factotum is to ...

## Installation

You can install the released version of factotum from [CRAN](https://CRAN.R-project.org) with:

``` r

install.packages("factotum")

```

And the development version from [GitHub](https://github.com/) with:

``` r

# install.packages("devtools")

devtools::install_github("thisisnic/factotum")

```

## Example

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

```{r example}

library(factotum)

## 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.

## Code of Conduct

  

Please note that the factotum project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.