Add a new annotation text

Source: R/db_describe_annotation.R

Add a new annotation text

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

Value

message if successful

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.

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")
#> Riparian wells has been entered into the Annotations table.
#> Use db_annotate to tag items with annotations.

db_describe_annotation(db,
annotationtext = "January sampling campaign",
annotationtypecv = "Specimen group",
annotationcode = "Jan")
#> January sampling campaign has been entered into the Annotations table.
#> Use db_annotate to tag items with annotations.