Change view_annotations_dictionary() name

Author: clnsmth

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+export(annotation_dictionary)
 export(calc_geo_extent_bounding_box_m2)
 export(calc_length_of_survey_years)
 export(calc_number_of_years_sampled)
@@ -29,7 +30,6 @@ export(read_data)
 export(save_data)
 export(search_data)
 export(validate_data)
-export(view_annotation_dictionary)
 export(write_tables)
 import(dplyr)
 import(ggplot2)

NEWS.md

@@ -4,7 +4,7 @@
 * Release new plotting functions for taxonomic and geographic exploration.
 * Allow multiple input types to the new `data` parameter of "use" functions (supercedes `dataset`), thereby simplifying and accelerating exploratory manipulation and plotting.
 * Reformat dataset object returned by `read_data()`. Generally, this simplifies dataset indexing and usage within iteration contexts. It removes a layer of nesting and places the dataset id at the same level as metadata, tables, and validation_issues.
-* Release new `view_annotation_dictionary f`unction. This feature will allow ecocomDP creators to view the semantic annotations for existing ecocomDP datasets. Annotation dictionary is published as an EDI data package to apply occasional updates.
+* Release new `annotation_dictionary()` function. This feature will allow ecocomDP creators to view the semantic annotations for existing ecocomDP datasets. Annotation dictionary is published as an EDI data package to apply occasional updates.
 * Release new `validate_mapped_id()` function. Ensures values listed under /variable_mapping/mapped_id resolve without error
 * Release new Model Overview vignette. The model overview vignette consists of the authoritative set of table descriptions, relationships, and requirements for the ecocomDP model and a visualization of table contents and relationships.
 * Release new Shared Practices Vignette. This document delineates the practices that all creators of ecocomDP formatted datasets should adopt in order for the community to build a cohesive and interoperable collection. It contains detailed descriptions of practices, definitions of concepts, and solutions to many common issues.

R/view_annotation_dictionary.R R/annotation_dictionary.R

@@ -11,10 +11,10 @@
 #' 
 #' @examples 
 #' \dontrun{
-#' view_annotation_dictionary()
+#' View(annotation_dictionary())
 #' }
 #'     
-view_annotation_dictionary <- function(){
+annotation_dictionary <- function(){
 
   ping_edi() # Warn if EDI is down
 
@@ -39,5 +39,5 @@ view_annotation_dictionary <- function(){
          file = paste0(tempdir(), "/annotation_dictionary_table.rda"), 
          version = 3)
   }
-  utils::View(ecocomDP_annotation_dictionary)
+  return(ecocomDP_annotation_dictionary)
 } 

_pkgdown.yml

@@ -45,7 +45,7 @@ reference:
     - calc_length_of_survey_years
     - calc_number_of_years_sampled
     - calc_std_dev_interval_betw_years
-    - view_annotation_dictionary
+    - annotation_dictionary
   - title: Example data
     desc: Example data
     contents:

man/view_annotation_dictionary.Rd man/annotation_dictionary.Rd

@@ -327,7 +327,7 @@ knitr::include_graphics('./LevelOfSurvey_final_long2.png')
 Value added information is anything that an ecocomDP creator intentionally adds to the L1 dataset to improve its findability, accessibility, interoperability, or reusability (see [FAIR Principles](https://www.go-fair.org/fair-principles/)). This information does not come from the L0 dataset directly, but instead is derived from it. Since the rule of thumb regarding L1 dataset creation is to rearrange but not alter the L0 dataset, supplementing a dataset with value added information must be done carefully and within the constraints of the following rules:
 
 *   Taxonomic coverage - Resolve taxa to a supported authority system and list in the taxon table *only* when the L0 dataset itself does not resolve taxa to an authority system. See [taxon](#taxon) for more details on resolving taxa to a supported authority.
-*   Annotations - Select annotations for variable_name values in the variable_mapping table. Additionally, include annotations of dataset features in the metadata. Only use annotations from the supported ontologies (see [Ontologies and Vocabularies](#ontologies) section) and always opt to use annotations that have been used in existing ecocomDP datasets (see `view_annotation_dictionary()` function).
+*   Annotations - Select annotations for variable_name values in the variable_mapping table. Additionally, include annotations of dataset features in the metadata. Only use annotations from the supported ontologies (see [Ontologies and Vocabularies](#ontologies) section) and always opt to use annotations that have been used in existing ecocomDP datasets (see `annotation_dictionary()` function).
 
 # Ontologies and Vocabularies {#ontologies}
 #### Natural observation vs. experiment/manipulation