-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add new logo and cleanse README
- Loading branch information
Showing
5 changed files
with
38 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,61 +1,44 @@ | ||
|
|
||
| <!-- README.md is generated from README.Rmd. Please edit that file --> | ||
|
|
||
| # noclocksR <img src="man/figures/logo.png" align="right" height="120" alt="" /> | ||
| # No Clocks R Package - `noclocksr` <img src="man/figures/noclocks-logo.png" align="right" width="120" height="auto" alt="No Clocks Logo" /> | ||
|
|
||
| > \[!NOTE\] This package is under active development and is not yet | ||
| > ready for use. | ||
| <!-- badges: start --> | ||
|
|
||
| [](https://lifecycle.r-lib.org/articles/stages.html#experimental) | ||
| [](http://www.repostatus.org/#wip) | ||
| [](https://github.com/noclocks/noclocksR/actions/workflows/changelog.yml) | ||
| [](https://github.com/noclocks/noclocksR/actions/workflows/pkgdown.yaml) | ||
| [](https://github.com/noclocks/noclocksR/actions/workflows/pages/pages-build-deployment) | ||
| <!-- badges: end --> | ||
|
|
||
| The goal of noclocksR is to … | ||
|
|
||
| ## Installation | ||
| ## Contents | ||
|
|
||
| You can install the development version of noclocksR from | ||
| [GitHub](https://github.com/) with: | ||
| - [Overview](#overview) | ||
| - [Installation](#installation) | ||
| - [Usage](#usage) | ||
| - [License](#license) | ||
|
|
||
| ``` r | ||
| # install.packages("devtools") | ||
| devtools::install_github("noclocks/noclocksR") | ||
| ``` | ||
| ## Overview | ||
|
|
||
| ## Example | ||
| The `noclocksr` package is a collection of functions and datasets for | ||
| use in No Clocks, LLC projects. | ||
|
|
||
| This is a basic example which shows you how to solve a common problem: | ||
|
|
||
| ``` r | ||
| # library(noclocksR) | ||
| ## basic example code | ||
| ``` | ||
| ## Installation | ||
|
|
||
| What is special about using `README.Rmd` instead of just `README.md`? | ||
| You can include R chunks like so: | ||
| You can install the development version of `noclocksr` from GitHub with: | ||
|
|
||
| ``` r | ||
| summary(cars) | ||
| #> speed dist | ||
| #> Min. : 4.0 Min. : 2.00 | ||
| #> 1st Qu.:12.0 1st Qu.: 26.00 | ||
| #> Median :15.0 Median : 36.00 | ||
| #> Mean :15.4 Mean : 42.98 | ||
| #> 3rd Qu.:19.0 3rd Qu.: 56.00 | ||
| #> Max. :25.0 Max. :120.00 | ||
| pak::pak("noclocks/noclocksr") | ||
| ``` | ||
|
|
||
| You’ll still need to render `README.Rmd` regularly, to keep `README.md` | ||
| up-to-date. `devtools::build_readme()` is handy for this. | ||
| ## Usage | ||
|
|
||
| You can also embed plots, for example: | ||
| The package is under active development and is not yet ready for use. | ||
|
|
||
| <img src="man/figures/README-pressure-1.png" width="100%" /> | ||
| ## License | ||
|
|
||
| In that case, don’t forget to commit and push the resulting figure | ||
| files, so they display on GitHub and CRAN. | ||
| The `noclocksr` package is free and open source software, licensed under | ||
| the [MIT License](LICENSE.md). |
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.