get_publication: A function to get publications for sites or datasets in the...

View source: R/get_publication.R

get_publicationR Documentation

A function to get publications for sites or datasets in the Neotoma Database using the API.

Description

The function takes the parameters, defined by the user, and returns a table with publication information from the Neotoma Paleoecological Database.

Usage

get_publication(x, contactid, datasetid, author, pubtype, year, search)

Arguments

x

Numeric Publication ID value, either from get_dataset or known.

contactid

Numeric Contact ID value, either from get_dataset or get_contact

datasetid

Numeric Dataset ID, known or from get_dataset

author

Character string for full or partial author's name. Can include wildcards such as 'Smit*' for all names beginning with 'Smit'.

pubtype

Character string, one of eleven allowable types, see get_table. For a list of allowed types run get_table("PublicationTypes").

year

Numeric publication year.

search

A character string to search for within the article citation.

Value

A list is returned with two data frame components:

meta

A single row with Publication ID, type, year of publication and full citation.

Authors

data.frame of author names, order and IDs, can be of variable length.

Author(s)

Simon J. Goring simon.j.goring@gmail.com

References

Neotoma Project Website: http://www.neotomadb.org API Reference: http://wnapi.neotomadb.org/doc/resources/contacts

Examples

## Not run: 
#  To find all publications from 1998:
year.cont <- get_publication(year = 1998)

# To find all data contributors who have the last name "Smith"
smith.cont <- get_publication(author = 'Smith')

## End(Not run)

ropensci/neotoma documentation built on Dec. 6, 2022, 6:26 p.m.