get_cristin_results: Get results from the Cristin API

In henrikkarlstrom/rcristin: Get Cristin results from the Cristin API

Description

get_cristin_results() takes in search parameters for the Cristin API and returns the results as a tibble.

Usage

get_cristin_results(..., page = 1, per_page = 999, fields = "all", NVI = FALSE)

Arguments

...	Arguments to pass on to Cristin API. See 'API parameters' below for more information.
page	Page number for pagination purposes, set to 1 by default
per_page	Number of items per page, set to 999 by default
fields	'all' by default, if omitted will return a minimal set of fields
NVI	Logical determining whether to return only peer-reviewed publications or all results, set to 'FALSE' by default

Value

A tibble with results from the API call, with one row per result.

API parameters The Cristin API recognises many search parameters.

You can find the latest specification at the Cristin API documentation page.

Here are examples of the formatting of these parameters:

parameter	description
doi	DOI name (e.g. doi=10.1000/123456)
title	The title of the result
contributor	Author's name or Cristin person id
issn	The issn of the result
unit	Id (e.g. unit=185.53.18.10)
institution	Id (one number, e.g. institution=185), name or acronym of the institution the contributors belong to
user	A person's username in Cristin together with the institution id separated by ':' askeladd:185' means Cristin user 'askeladd' from the institution '185'
category	Result category code, see Cristin category codes for specification
published_since	Results published since and inclusive the given year, (yyyy), e.g: 2005
published_before	Results published before and inclusive the given year, (yyyy), e.g: 2017
created_since	Results created since and inclusive the given date, (yyyy-mm-dd), e.g: 2005-03-17
created_before	Results created before and inclusive the given date, (yyyy-mm-dd), e.g: 2005-03-17
modified_since	Results modified since and inclusive the given date, (yyyy-mm-dd), e.g: 2005-03-17
modified_before	Results modified before and inclusive the given date, (yyyy-mm-dd), e.g: 2005-03-17
year_reported	The year a result was reported
project_code	Project code is the internal reference number used by funding source
funding_source	Funding source code e.g: NFR
funding	Funding source code e.g: NFR, and project_code together separated by ':' 'NFR:1234' means 'funding_source': NFR' with 'project_code': '1234'
lang	Two letter language code that determines value of fields such as institution name, one of 'en' (default), 'nb', or 'nn'.

Examples

get_cristin_results(contributor = "25062")

henrikkarlstrom/rcristin documentation built on Dec. 19, 2020, 9:37 a.m.