Learn R Programming

regcensus (version 1.0.1)

get_documents: get_documents

Description

Get metadata for documents available in a specific jurisdiction or for a specific document ID

Usage

get_documents(
  document_id = NULL,
  jurisdiction_id = NULL,
  date = NULL,
  document_type = 1,
  verbose = 0
)

Value

Returns pandas dataframe with the metadata

Arguments

document_id

ID of the specific document

jurisdiction_id

ID for the jurisdiction

date

Year(s) of the documents

document_type

ID for type of document, default value of 1

verbose

prints out the url of the API call, default value of 0

Examples

Run this code
if (FALSE) get_documents(jurisdiction_id = 38, date = 2022)

Run the code above in your browser using DataLab