rmacrostrat (version 1.0.0)

def_projects: Retrieve metadata for Macrostrat projects

Description

A function to obtain information concerning the different Macrostrat projects. If no arguments are specified (default), data for all projects are returned.

Usage

def_projects(project_id = NULL)

Value

A data.frame containing:

• project_id: The unique identification number of the Macrostrat project.

• project: The name of the Macrostrat project.

• descrip: Description of the Macrostrat project.

• timescale_id: The unique identification number of the timescale used in the Macrostrat project.

• t_cols: The total number of Macrostrat columns associated with the project.

• in_process_cols: The total number of in-progress Macrostrat columns associated with the project.

• obsolete_cols: The total number of obsolete Macrostrat columns associated with the project.

• t_units: The total number of Macrostrat units associated with the project.

• area: The area covered by the Macrostrat project in km².

Arguments

project_id

integer. The unique identification number(s) of the desired project(s) to return a definition for.

Developer(s)

Bethany Allen

Reviewer(s)

Lewis A. Jones

See Also

Macrostrat database metadata: def_references(), def_sources(), get_stats()

Examples

# \donttest{
 ex1 <- def_projects()
 ex2 <- def_projects(project_id = 4)
# }