new_external_object: Post entry to external_object table

In FAIRDataPipeline/rDataPipeline: Functions to Interact with the 'FAIR Data Pipeline'

Post entry to external_object table

Description

Upload information to the external_object table in the data registry

Usage

new_external_object(
  doi_or_unique_name,
  primary_not_supplement = TRUE,
  release_date,
  title,
  description,
  data_product_url,
  original_store_url,
  endpoint = "http://127.0.0.1:8000/api/"
)

Arguments

doi_or_unique_name	a string specifying the DOI or name of the external_object
primary_not_supplement	(optional) a boolean flag to indicate whether the external object is the primary source (TRUE) or not (FALSE)
release_date	the date-time that the external_object was released e.g. Sys.time() or "2010-07-11 12:15:00 BST"
title	a string specifying the title of the external_object
description	(optional) a string containing a free text description of the external_object
data_product_url	a string specifying the URL of an entry in the data_product table
original_store_url	(optional) a string specifying the URL of a an entry in the storage_location table that references the original location of an external_object
endpoint	a string specifying the registry endpoint

See Also

Other new functions: new_author(), new_code_repo_release(), new_code_run(), new_data_product(), new_file_type(), new_issue(), new_keyword(), new_licence(), new_namespace(), new_object(), new_object_component(), new_quality_controlled(), new_storage_location(), new_storage_root(), new_user_author()

FAIRDataPipeline/rDataPipeline documentation built on Dec. 4, 2024, 4:09 a.m.