get_next_version: get the next version of a data package

In CAPLTER/capeml: CAP LTER package for generating EML

get the next version of a data package

Description

get_next_version will access the EDI API to identify and return the next version of a data package. If the data package does not exist (i.e., we are constructing a new package), get_next_version will return '1' and display a corresponding note.

Usage

get_next_version(
  provided_scope = "knb-lter-cap",
  provided_identifier,
  display_message = FALSE
)

Arguments

provided_scope	(character) scope of data package (defaults to CAP LTER: knb-lter-cap)
provided_identifier	(integer) identifier of data package
display_message	(boolean) indicates whether to display a message if an existing dataset is not identifed in the repository (thus returning a version number 1)

Details

get_next_version is a helper function designed to aid construction of a package identifier (e.g., the version '5' of 'knb-lter-cap.624.5'). As such, the most common use case is that the function will be called internally from capeml::createDataset but the function can be called directly.

Value

integer reflecting the next version of a data package

Examples

## Not run: 

get_next_version(
  provided_scope      = "knb-lter-cap",
  provided_identifier = 624
)


## End(Not run)
#'

CAPLTER/capeml documentation built on Dec. 23, 2024, 6:29 a.m.