https://github.com/noclocks/noclocksr

R Package for No Clocks, LLC
https://github.com/noclocks/noclocksr

developer-tools helpers internal r-package utility

Last synced: about 1 month ago
JSON representation

R Package for No Clocks, LLC

• Host: GitHub
• URL: https://github.com/noclocks/noclocksr
• Owner: noclocks
• License: other
• Created: 2024-02-07T18:37:13.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-07-11T18:29:53.000Z (2 months ago)
• Last Synced: 2024-07-12T21:32:16.358Z (2 months ago)
• Topics: developer-tools, helpers, internal, r-package, utility
• Language: HTML
• Homepage: https://docs.noclocks.dev/noclocksR/
• Size: 9 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - noclocks/noclocksr - R Package for No Clocks, LLC (HTML)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# noclocksR 

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

[![Project Status: WIP](https://www.repostatus.org/badges/latest/wip.svg)](http://www.repostatus.org/#wip)

[![Generate CHANGELOG.md](https://github.com/noclocks/noclocksR/actions/workflows/changelog.yml/badge.svg)](https://github.com/noclocks/noclocksR/actions/workflows/changelog.yml)

[![pkgdown](https://github.com/noclocks/noclocksR/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/noclocks/noclocksR/actions/workflows/pkgdown.yaml)

[![pages-build-deployment](https://github.com/noclocks/noclocksR/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/noclocks/noclocksR/actions/workflows/pages/pages-build-deployment)

The goal of noclocksR is to ...

## Installation

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

``` r

# install.packages("devtools")

devtools::install_github("noclocks/noclocksR")

```

## Example

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

```{r example}

# library(noclocksR)

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