Skip to contents

Retrieves the ontologies registered on the server: metadata about each ontology (name, version, authors, description, ...), not the trait terms that belong to it. brapi_traits(), brapi_scales(), brapi_methods(), and brapi_observation_variables() each carry an ontology reference back to one of these records.

Usage

brapi_ontologies(con, ...)

Arguments

con

A brapi_connection() object.

...

Additional query parameters.

Value

A tibble with one row per ontology.

BrAPI endpoint

GET /ontologies - see the v2.1 specification.

Query parameters the specification defines, which may be passed through ...:

ontologyName.

See also

brapi_ontology() for a single ontology by ID; brapi_traits(), brapi_scales(), brapi_methods(), and brapi_observation_variables() for the records that reference these ontologies.

Examples

# \donttest{
con <- brapi_connection("https://test-server.brapi.org")
brapi_ontologies(con)
#> # A tibble: 199 × 10
#>    additionalInfo   externalReferences authors copyright      description       
#>    <list>           <lgl>              <chr>   <chr>          <chr>             
#>  1 <NULL>           NA                 NA      NA             NA                
#>  2 <NULL>           NA                 NA      NA             NA                
#>  3 <NULL>           NA                 NA      NA             NA                
#>  4 <NULL>           NA                 NA      NA             NA                
#>  5 <NULL>           NA                 NA      NA             NA                
#>  6 <NULL>           NA                 NA      NA             NA                
#>  7 <named list [1]> NA                 Bob     2017 brapi.org Ontology.org      
#>  8 <named list [1]> NA                 Bob     2017 brapi.org Custom Maize Onto…
#>  9 <named list [1]> NA                 Bob     2017 brapi.org Custom Pawpaw Ont…
#> 10 <NULL>           NA                 NA      NA             NA                
#> # ℹ 189 more rows
#> # ℹ 5 more variables: documentationURL <chr>, licence <chr>,
#> #   ontologyName <chr>, version <chr>, ontologyDbId <chr>
# }