-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
62 lines (43 loc) · 1.4 KB
/
README.Rmd
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
---
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%"
)
```
# jirarest
<!-- badges: start -->
[![R-CMD-check](https://github.com/TalhoukLab/jirarest/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/TalhoukLab/jirarest/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
The goal of jirarest is to provide a REST API in R for accessing the BCGSC Jira ticketing system.
## Installation
You can install the development version of jirarest from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("TalhoukLab/jirarest")
```
## Examples
Here are examples of the currently implemented resources.
### Create Issue
An issue can be created within a Jira project.
```{r create-issue, eval=FALSE}
library(jirarest)
create_issue(project = "BC",
summary = "new analysis",
description = "analysis for someone")
```
### Add Comment
We can add comments to existing issues. Assumes that the current working directory is the name of issue.
```{r add-comment, eval=FALSE}
add_comment("report completed")
```
### Attach File
Files such as PDF reports and data can be attached to issues.
```{r attach-file, eval=FALSE}
attach_file("/path/to/file")
```