README.Rmd

---
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%"
)
```

# nva

<!-- badges: start -->
[![R-CMD-check](https://github.com/capro-uio/nva/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/capro-uio/nva/actions/workflows/R-CMD-check.yaml)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![Coverage](https://raw.githubusercontent.com/capro-uio/nva/coverage/badges/coverage.svg)](https://github.com/capro-uio/nva/actions/workflows/test-coverage.yaml)
<!-- badges: end -->

{nva} provides an R interface to the [Nasjonalt Vitenarkiv (NVA)](https://nva.sikt.no) API,
the Norwegian national research archive maintained by [Sikt](https://sikt.no).

## Installation

Install the development version from GitHub:

```r
# install.packages("pak")
pak::pak("capro-uio/nva")
```

## Setup

Most read and search endpoints work without authentication.
For authenticated access (required for write operations and to avoid throttling),
request API credentials at <https://nettskjema.no/a/nva-api-tilgang> and set:

```r
Sys.setenv(
  NVA_CLIENT_ID = "your-client-id",
  NVA_CLIENT_SECRET = "your-client-secret"
)
```

We recommend adding these to your `.Renviron` file.
Run `nva_sitrep()` to verify your setup.

## Usage

```{r example, eval = FALSE}
library(nva)

nva_search(query = "machine learning", institution = "uio")

nva_publication("01907b24c6da-065e37af-5849-4602-b77c-d4d0d4e0ef31")

nva_person("12345")

nva_organizations(query = "Universitetet i Oslo")
```

To use the test/sandbox environment:

```r
Sys.setenv(NVA_API_ENV = "test")
```

## Diagnostics

```{r sitrep, eval = FALSE}
nva_sitrep()
```

This checks your credentials, API connectivity, and package configuration.