new_object_component: Post entry to object_component table

View source: R/new_object_component.R

new_object_componentR Documentation

Post entry to object_component table

Description

Upload information to the object_component table in the data registry

Usage

new_object_component(
  object_url,
  name,
  description,
  whole_object = FALSE,
  issues_urls,
  endpoint = "http://127.0.0.1:8000/api/"
)

Arguments

object_url

a string specifying the URL of an existing object

name

a string specifying the name of the object_component, unique in the context of object_component and its object reference

description

(optional) a string containing a free text description of the object_component

whole_object

a boolean flag specifying whether or not this object_component refers to the whole object or not - default is FALSE

issues_urls

(optional) a list of issues URLs to associate with this object

endpoint

a string specifying the registry endpoint

Note that the object_component table contains issues as an additional optional field. This is not included here. Instead use attach_issue() and associated functionality to attach issues to objects and object components.

See Also

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


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