https://github.com/hunzikp/velox

https://github.com/hunzikp/velox

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/hunzikp/velox
• Owner: hunzikp
• Created: 2016-08-14T16:24:40.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-11-04T02:12:44.000Z (11 months ago)
• Last Synced: 2024-06-11T19:12:29.087Z (3 months ago)
• Language: R
• Homepage: https://hunzikp.github.io/velox/
• Size: 2.15 MB
• Stars: 119
• Watchers: 11
• Forks: 23
• Open Issues: 27
• Metadata Files:
  • Readme: README.Rmd

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

)

```

# velox

The goal of velox is to ...

## Installation

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

``` r

install.packages("velox")

```

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

``` r

# install.packages("devtools")

devtools::install_github("Jean-Romain/velox")

```

## Example

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

```{r example}

library(velox)

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