list_ecotox_fields: List the field names that are available from the ECOTOX...

View source: R/database_access.r

list_ecotox_fieldsR Documentation

List the field names that are available from the ECOTOX database

Description

List the field names (table headers) that are available from the ECOTOX database

Usage

list_ecotox_fields(
  which = c("default", "extended", "full", "all"),
  include_table = TRUE
)

Arguments

which

A character string that specifies which fields to return. Can be any of: 'default': returns default output field names; 'all': returns all fields; 'extended': returns all fields of the default tables; or 'full': returns all fields except those from tables 'chemical_carriers', 'media_characteristics', 'doses', 'dose_responses', 'dose_response_details', 'dose_response_links' and 'dose_stat_method_codes'.

include_table

A logical value indicating whether the table name should be included as prefix. Default is TRUE.

Details

This can be useful when specifying a search_ecotox, to identify which fields are available from the database, for searching and output.

Value

Returns a vector of type character containing the field names from the ECOTOX database.

Author(s)

Pepijn de Vries

Examples

## Fields that are included in search results by default:
list_ecotox_fields("default")

## All fields that are available from the ECOTOX database:
list_ecotox_fields("all")

## All except fields from the tables 'chemical_carriers', 'media_characteristics', 'doses',
## 'dose_responses', 'dose_response_details', 'dose_response_links' and 'dose_stat_method_codes'
## that are available from the ECOTOX database:
list_ecotox_fields("full")

ECOTOXr documentation built on Nov. 17, 2022, 5:07 p.m.