lineaR/README.Rmd at main · Presage-Group/lineaR · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# lineaR

<!-- badges: start -->
<!-- badges: end -->

The goal of lineaR is to provide a simple interface for working with data from linear.app in R.

## Installation

You can install the development version of lineaR like so:

``` r
devtools::install_github("Presage-Group/lineaR")
```

## Getting an API Key From Linear

You will need a personal Linear API key in order to use this package. This can be generated at the [security settings page](https://linear.app/presagegroup/settings/account/security) within linear. Store this key in your `keyring` with the provided utility function `store_linear_api_key` and it will be retrieved when needed.

## Example

```r
library(lineaR)

get_linear_current_user()

# A tibble: 1 × 3
# id                                   name        email
# <chr>                                <chr>       <chr>
# 1 ---------------------------------  Randy Boyes rboyes@presagegroup.com

```