https://github.com/ropensci-archive/tl

:no_entry: ARCHIVED :no_entry: Quick Ref. Guides For R Functions
https://github.com/ropensci-archive/tl

ozunconf18 r r-package rstats tldr unconf

Last synced: 3 months ago
JSON representation

:no_entry: ARCHIVED :no_entry: Quick Ref. Guides For R Functions

• Host: GitHub
• URL: https://github.com/ropensci-archive/tl
• Owner: ropensci-archive
• License: other
• Archived: true
• Created: 2018-11-22T01:02:37.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-05-10T14:13:51.000Z (over 2 years ago)
• Last Synced: 2024-05-21T02:12:33.917Z (6 months ago)
• Topics: ozunconf18, r, r-package, rstats, tldr, unconf
• Language: R
• Homepage:
• Size: 50.8 KB
• Stars: 51
• Watchers: 5
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README-NOT.md
  • License: LICENSE

Awesome Lists containing this project

README

        


tl

==

[![Project Status: Abandoned – Initial development has started, but there has not yet been a stable, usable release; the project has been abandoned and the author(s) do not intend on continuing development.](https://www.repostatus.org/badges/latest/abandoned.svg)](https://www.repostatus.org/#abandoned)

[![Travis build status](https://travis-ci.org/ropenscilabs/tl.svg?branch=master)](https://travis-ci.org/ropenscilabs/tl) [![Codecov test coverage](https://codecov.io/gh/ropenscilabs/tl/branch/master/graph/badge.svg)](https://codecov.io/gh/ropenscilabs/tl?branch=master)

The goal of tl is to provide an R equivalent to the tldr command line tool, a community-contributed set of quick reference guides for R functions.

> "Perfection is achieved not when there is nothing more to add, but when there is nothing left to take away" - Antoine de Saint-Exupéry

Briefly forgotten how a function works? Don't want to scroll through a long help file to find the example usage? You need tl;dr!

Installation

------------

You can install the current version of tl from [github](https://github.com) with:

``` r

devtools::install_github("ropenscilabs/tl")

```

Examples

--------

Here are some basic examples of how to use tl:

Use the `dr` function to find a help page

``` r

tl::dr(lm)

```

> ``` r

> fits a linear model

>

> - fits a linear model of y dependent on x1 and x2

>   m1 <- lm(y ~ x1 + x2)

>

> - fits on data in data frame df

>   m1 <- lm(y ~ x1 + x2, data = df)

>

> - fits model of y on categorical variable xc

>   m1 <- lm(y ~ as.factor(xc), data = df)

>

> - print model

>   summary(m1)

> ```

``` r

tl::dr(tidyr::gather)

```

> ``` r

> tidyr::gather

>

> converts data from wide to long

>

> - collapse columns x1 to x5 into 5 rows

>   gather(data, key = "key", value = "value", x1:x5)

>

> - collapse all columns

>   gather(data, key = "key", value = "value")

> ```

Page you are looking for does not exist? Use the `create_page` function to make one! Please follow the instructions to keep it brief.

``` r

tl::create_page(base::system.file)

```

Want to submit your new page to the `tl` package? Use the `submit_page` function to get instructions on how to add your help page to `tl`.

``` r

tl::submit_page(base::system.file)

```