SEO.JSONLD.BioChemEntity (SEO v0.3.0-rc.0)

Any biological, chemical, or biochemical thing. For example: a protein; a gene; a chemical; a synthetic chemical.

Helper for building a Schema.org BioChemEntity JSON-LD structure.

Summary

Types

attrs()

t()

A JSON-LD map ready to be nested or rendered. String-keyed, always includes "@type" set to "BioChemEntity", plus any camelCased field keys the caller provided (see build/1). "@context" is added at render time by SEO.JSONLD.meta/1 on the top-level node only.

Functions

build(attrs)

Build a BioChemEntity JSON-LD map.

Types

attrs()

@type attrs() ::
  %{
    optional(:associated_disease) =>
      SEO.JSONLD.PropertyValue.t()
      | map()
      | SEO.JSONLD.MedicalCondition.t()
      | URI.t()
      | String.t(),
    optional(:bio_chem_interaction) => t() | map(),
    optional(:bio_chem_similarity) => t() | map(),
    optional(:biological_role) => SEO.JSONLD.DefinedTerm.t() | map(),
    optional(:funding) => SEO.JSONLD.Grant.t() | map(),
    optional(:has_bio_chem_entity_part) => t() | map(),
    optional(:has_molecular_function) =>
      SEO.JSONLD.PropertyValue.t()
      | map()
      | SEO.JSONLD.DefinedTerm.t()
      | URI.t()
      | String.t(),
    optional(:has_representation) =>
      String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
    optional(:is_encoded_by_bio_chem_entity) => SEO.JSONLD.Gene.t() | map(),
    optional(:is_involved_in_biological_process) =>
      SEO.JSONLD.PropertyValue.t()
      | map()
      | SEO.JSONLD.DefinedTerm.t()
      | URI.t()
      | String.t(),
    optional(:is_located_in_subcellular_location) =>
      SEO.JSONLD.DefinedTerm.t()
      | map()
      | URI.t()
      | String.t()
      | SEO.JSONLD.PropertyValue.t(),
    optional(:is_part_of_bio_chem_entity) => t() | map(),
    optional(:taxonomic_range) =>
      SEO.JSONLD.DefinedTerm.t()
      | map()
      | String.t()
      | URI.t()
      | SEO.JSONLD.Taxon.t(),
    optional(:additional_type) => String.t() | URI.t(),
    optional(:alternate_name) => String.t(),
    optional(:description) => SEO.JSONLD.TextObject.t() | map() | String.t(),
    optional(:disambiguating_description) => String.t(),
    optional(:identifier) =>
      String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
    optional(:image) =>
      URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
    optional(:main_entity_of_page) =>
      SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
    optional(:name) => String.t(),
    optional(:owner) =>
      SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
    optional(:potential_action) => SEO.JSONLD.Action.t() | map(),
    optional(:same_as) => URI.t() | String.t(),
    optional(:subject_of) =>
      SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
    optional(:url) => URI.t() | String.t()
  }
  | [
      associated_disease:
        SEO.JSONLD.PropertyValue.t()
        | map()
        | SEO.JSONLD.MedicalCondition.t()
        | URI.t()
        | String.t(),
      bio_chem_interaction: t() | map(),
      bio_chem_similarity: t() | map(),
      biological_role: SEO.JSONLD.DefinedTerm.t() | map(),
      funding: SEO.JSONLD.Grant.t() | map(),
      has_bio_chem_entity_part: t() | map(),
      has_molecular_function:
        SEO.JSONLD.PropertyValue.t()
        | map()
        | SEO.JSONLD.DefinedTerm.t()
        | URI.t()
        | String.t(),
      has_representation:
        String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
      is_encoded_by_bio_chem_entity: SEO.JSONLD.Gene.t() | map(),
      is_involved_in_biological_process:
        SEO.JSONLD.PropertyValue.t()
        | map()
        | SEO.JSONLD.DefinedTerm.t()
        | URI.t()
        | String.t(),
      is_located_in_subcellular_location:
        SEO.JSONLD.DefinedTerm.t()
        | map()
        | URI.t()
        | String.t()
        | SEO.JSONLD.PropertyValue.t(),
      is_part_of_bio_chem_entity: t() | map(),
      taxonomic_range:
        SEO.JSONLD.DefinedTerm.t()
        | map()
        | String.t()
        | URI.t()
        | SEO.JSONLD.Taxon.t(),
      additional_type: String.t() | URI.t(),
      alternate_name: String.t(),
      description: SEO.JSONLD.TextObject.t() | map() | String.t(),
      disambiguating_description: String.t(),
      identifier: String.t() | URI.t() | SEO.JSONLD.PropertyValue.t() | map(),
      image: URI.t() | String.t() | SEO.JSONLD.ImageObject.t() | map(),
      main_entity_of_page:
        SEO.JSONLD.CreativeWork.t() | map() | URI.t() | String.t(),
      name: String.t(),
      owner: SEO.JSONLD.Organization.t() | map() | SEO.JSONLD.Person.t(),
      potential_action: SEO.JSONLD.Action.t() | map(),
      same_as: URI.t() | String.t(),
      subject_of: SEO.JSONLD.Event.t() | map() | SEO.JSONLD.CreativeWork.t(),
      url: URI.t() | String.t()
    ]

t()

@type t() :: %{required(String.t()) => term()}

Functions

build(attrs)

@spec build(attrs()) :: t()

Build a BioChemEntity JSON-LD map.

Fields

:associated_disease - Disease associated to this BioChemEntity. Such disease can be a MedicalCondition or a URL. If you want to add an evidence supporting the association, please use PropertyValue.
:bio_chem_interaction - A BioChemEntity that is known to interact with this item.
:bio_chem_similarity - A similar BioChemEntity, e.g., obtained by fingerprint similarity algorithms.
:biological_role - A role played by the BioChemEntity within a biological context.
:funding - A SEO.JSONLD.Grant that directly or indirectly provide funding or sponsorship for this item. See also ownershipFundingInfo.
:has_bio_chem_entity_part - Indicates a BioChemEntity that (in some sense) has this BioChemEntity as a part.
:has_molecular_function - Molecular function performed by this BioChemEntity; please use PropertyValue if you want to include any evidence.
:has_representation - A common representation such as a protein sequence or chemical structure for this entity. For images use schema.org/image.
:is_encoded_by_bio_chem_entity - Another BioChemEntity encoding by this one.
:is_involved_in_biological_process - Biological process this BioChemEntity is involved in; please use PropertyValue if you want to include any evidence.
:is_located_in_subcellular_location - Subcellular location where this BioChemEntity is located; please use PropertyValue if you want to include any evidence.
:is_part_of_bio_chem_entity - Indicates a BioChemEntity that is (in some sense) a part of this BioChemEntity.
:taxonomic_range - The taxonomic grouping of the organism that expresses, encodes, or in some way related to the BioChemEntity.

Inherited properties

Additional properties are available through the inheritance chain. See each ancestor's docs for its properties:

SEO.JSONLD.Thing