db_describe_annotation: Add a new annotation text

In khondula/rodm2: Use an ODM2 Database in R

Description

Add a new annotation text

Usage

db_describe_annotation(db, annotationtext = NULL,
  annotationtypecv = NULL, annotationcode = NULL)

Arguments

db	database connection object
annotationtext	text string of annotation.
annotationtypecv	annotation type from controlled vocab
annotationcode	Optional short codename for annotation

Details

Use this function to add new annotations such as the name of a Site group. Annotation text is required but if an annotation code is provided then that will be used as the annotation text as well.

Value

message if successful

See Also

Other describe functions: db_describe_equipment, db_describe_method, db_describe_organization, db_describe_person, db_describe_site, db_describe_variable

Examples

db <- create_sqlite(connect = TRUE)

db_describe_annotation(db,
annotationtext = "Riparian wells",
annotationtypecv = "Site group")

db_describe_annotation(db,
annotationtext = "January sampling campaign",
annotationtypecv = "Specimen group",
annotationcode = "Jan")

khondula/rodm2 documentation built on Jan. 9, 2020, 1:48 p.m.