ZINC15:help

From DISI
Jump to: navigation, search

Each resource in ZINC15 has an associated help page. Thus for substances, the page is /substances/help.

Each /<resource>/help page is divided into six sections, which we take up in turn below. Please look elsewhere for the ZINC15:Syntax or ZINC15 query URLs.

Header

  • Identifying attribute: this is how items of this resource are called in the URL. Thus for instance, substances have their zinc_id as an identifying attribute, and correspondingly the URL for say ZINC molecule 7 would be /substances/7 or /substances/ZINC7.
  • Resource name: This is the plural form of the resource, and is used as the first item in the URL.
  • Endpoint root: This seems to always just be the resource name surrounded by forward slash (/). Teague: is there a subtlety here I've missed?
  • Endpoint home: The /home/ endpoint is the default destination from the menu. The home resource typically allows access to help, examples, browsing, subsets and free text search of that resource. The page may also contain other features. The Tranche Browser is an important exception to this rule.
  • Subsets: N. The number of subsets. Links to the URL /<resource name>/subsets/

Attributes

The remainder of the page is organized into columns as follows:

  • Name: this is the name of the attributes as used in the URL, whether as a part of the query string (after the ?) or as a column specification (after the colon (:) but before the ?)
  • Type: This is the data type, and it literally how the data are represented in computer code. . In general, we try to perform type conversions automatically, to make your life easier, but type does limit the kinds of queries that may be asked and arguments that are considered acceptable.
  • Description: This is an English explanation of what the attribute is.
  • Searchable: If True, then this attribute is valid in the query string (after the ?). All attributes are valid as a column specification (after : and before ?).

Columns

Explanation of what columns are

Hybrids (computed in database)

Hybrids are computed in the database, but are otherwise treated just like columns, above.

Aliases to related resource attributes

Aliases are values drawn from other tables, but are otherwise treated just like columns, above.

Computed properties

Computed properties are just that - they are calculated, otherwise, treated just like columns.

Related resources

These are drawn from other tables, otherwise treated much like columns.