https://github.com/shanej90/gtR

Simplified access to the UKRI Gateway to Research (GtR) API via R.
https://github.com/shanej90/gtR

Last synced: 8 days ago
JSON representation

Simplified access to the UKRI Gateway to Research (GtR) API via R.

• Host: GitHub
• URL: https://github.com/shanej90/gtR
• Owner: shanej90
• License: gpl-3.0
• Created: 2021-10-11T14:34:56.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-11T07:58:41.000Z (almost 3 years ago)
• Last Synced: 2024-08-13T07:11:35.759Z (4 months ago)
• Language: R
• Homepage: https://shanej90.github.io/gtR
• Size: 1.22 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE.md

Awesome Lists containing this project

• jimsghstars - shanej90/gtR - Simplified access to the UKRI Gateway to Research (GtR) API via R. (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

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

  out.width = "100%"

)

```

# gtR





`gtR` is a tool for accessing UK Research and Innovation's (UKRI) [Gateway to Research](https://gtr.ukri.org/) (GtR) API. It is designed to reduce repetitive code when calling the API via R. This also helps eliminates barriers to users who aren't familiar with APIs more generally.

## Installation

You can install the package from [GitHub](https://github.com/shanej90/gtR) using the following code:

``` {r install, eval = F }

remotes::install_github("shanej90/gtR")

```

## Example

This is a basic example which shows you how to solve a common problem (results aren't shown due to long character strings in data):

```{r example}

library(gtR)

# get list of projects

data <- get_resources(

  resource = "project",

  size = 10,

  page_num = 1

)

```

## Enhancements

Although the intention to expand this package's functionality over time, if you can't wait feel free to fork and add functionality. In this case you may find UKRI's [API documentation](https://gtr.ukri.org/resources/GtR-2-API-v1.7.5.pdf) useful.

## Logo credit

Gate icon made from [Icon Fonts](http://www.onlinewebfonts.com/icon). Licensed by CC BY 3.0.