@hestia-earth/schema/Property.d.ts

HESTIA Schema

import { JSON, SchemaType } from './types';
import { Term } from './Term';
import { Source } from './Source';
import { TermTermType } from './Term';
export declare enum PropertyStatsDefinition {
    cycles = "cycles",
    modelled = "modelled",
    'other observations' = "other observations",
    regions = "regions",
    replications = "replications",
    simulated = "simulated",
    sites = "sites",
    spatial = "spatial",
    time = "time"
}
export declare enum PropertyMethodClassification {
    'consistent external sources' = "consistent external sources",
    'estimated with assumptions' = "estimated with assumptions",
    'expert opinion' = "expert opinion",
    'inconsistent external sources' = "inconsistent external sources",
    modelled = "modelled",
    'non-verified survey data' = "non-verified survey data",
    'physical measurement' = "physical measurement",
    'unsourced assumption' = "unsourced assumption",
    'verified survey data' = "verified survey data"
}
export declare enum PropertyDataState {
    complete = "complete",
    missing = "missing",
    'not required' = "not required",
    'requires validation' = "requires validation",
    unassigned = "unassigned"
}
/**
 * Contains all the TermTermType with override on the Property.
 * Note: it does not contain the default TermTermType on related Blank Nodes.
 */
export declare const propertyTermTermType: {
    term: TermTermType[];
    methodModel: TermTermType[];
    all: TermTermType[];
};
/**
 * Properties allow further information to be added to [Animals](/schema/Animal), [Products](/schema/Product), [Inputs](/schema/Input), [Emissions](/schema/Emission), and [Practices](/schema/Practices). Default Properties are also associated with [Terms](/schema/Term) (such as the average [nitrogen content](/term/nitrogenContent) of manure).
 */
export declare class Property extends JSON<SchemaType.Property> {
    /**
    * A reference to the [Term](/schema/Term) describing the Property.
    */
    term?: Term;
    /**
    * A description of the Property.
    */
    description?: string;
    /**
    * If the data associated with the Property are in key:value form, the key. E.g., in a list of pesticide active ingredients in a pesticide brand, the id of the key might be 'CAS-1071-83-6' and the value might be 25 percent.
    */
    key?: Term;
    /**
    * The value of the Property.
    */
    value?: number | boolean;
    /**
    * The percentage of the [Product](/schema/Product) or [Input](/schema/Input) value the Property refers to (e.g., if 70% of the steers sold are 450 days old and the remaining 30% are 900 days old, the term [Beef cattle, steer]((/term/beefCattleSteer) should be recorded once, with two [Age](/term/age) properties associated with it: the first one with [value](/schema/Property#value) 450 and share 70, the second one with [value](/schema/Property#value) 900 and share 30).
    */
    share?: number;
    /**
    * The standard deviation of <code>[value](/schema/Property#value)</code>.
    */
    sd?: number;
    /**
    * The minimum of <code>[value](/schema/Property#value)</code>.
    */
    min?: number;
    /**
    * The maximum of <code>[value](/schema/Property#value)</code>.
    */
    max?: number;
    /**
    * What the descriptive statistics (<code>[sd](/schema/Property#sd)</code>, <code>[min](/schema/Property#min)</code>, <code>[max](/schema/Property#max)</code>, and <code>[value](/schema/Property#value)</code>) are calculated across, or whether they are simulated or the output of a model. <code>spatial</code> refers to descriptive statistics calculated across spatial units (e.g., pixels) within a region or country. <code>time</code> refers to descriptive statistics calculated across units of time (e.g., hours).
    */
    statsDefinition?: PropertyStatsDefinition;
    /**
    * The number of observations the descriptive statistics are calculated over.
    */
    observations?: number;
    /**
    * The date in which the Property was measured in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, YYYY, --MM-DD, --MM, or YYYY-MM-DDTHH:mm:ssZ).
    */
    date?: string;
    /**
    * For Properties over periods different to [Cycle](/schema/Cycle), the start date of the Property (if different from the start date of the [Cycle]) in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
    */
    startDate?: string;
    /**
    * For Properties over periods different to [Cycle](/schema/Cycle), the end date of the Property (if different from the end date of the [Cycle]) in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
    */
    endDate?: string;
    /**
    * A reference to the [Term](/schema/Term) describing the method or model for acquiring or estimating these data.
    */
    methodModel?: Term;
    /**
    * A free text field, describing the method or model used for acquiring or estimating these data.
    */
    methodModelDescription?: string;
    /**
    * A classification of the method used to acquire or estimate the <code>[term](/schema/Property#term)</code> and <code>[value](/schema/Property#value)</code>. Overrides the <code>[defaultMethodClassification](/schema/Cycle#defaultMethodClassification)</code> specified in the [Cycle](/schema/Cycle). <ul class="is-pl-3 is-list-style-disc">  <li>
      <code>physical measurement</code> means the amount is quantified using weighing,
      volume measurement, metering, chemical methods, or other physical approaches.
    </li>
    <li>
      <code>verified survey data</code> means the data are initially collected through
      surveys; all or a subset of the data are verified using physical methods; and
      erroneous survey data are discarded or corrected.
    </li>
    <li>
      <code>non-verified survey data</code> means the data are collected through
      surveys that have not been subjected to verification.
    </li>
    <li>
      <code>modelled</code> means a previously calibrated model is used to estimate
      this data point from other data points describing this Cycle.
    </li>
    <li>
      <code>estimated with assumptions</code> means a documented assumption is used
      to estimate this data point from other data points describing this Cycle.
    </li>
    <li>
      <code>consistent external sources</code> means the data are taken from external
      datasets referring to different producers/enterprises:
      <ul class="is-pl-4 is-list-style-disc">
        <li>
          Using the same technology (defined as the same
          [System](/glossary?termType=system) or the same key [Practices](/schema/Practice)
          as those specified in the Cycle);
        </li>
        <li>
          At the same date (defined as occurring within the
          [startDate](/schema/Cycle#startDate) and [endDate](/schema/Cycle#endDate) of the Cycle);
          and
        </li>
        <li>
          In the same [region](/schema/Site#region) or [country](/schema/Site#country).
        </li>
      </ul>
      Modelling or assumptions may have also been used to transform these data.
    </li>
    <li>
      <code>inconsistent external sources</code> means the data are taken from external
      datasets referring to different producers/enterprises:
      <ul class="is-pl-4 is-list-style-disc">
        <li>
          Using a different technology (defined as a different
          [System](/glossary?termType=system) or using different key
          [Practices](/schema/Practice) to those specified in the Cycle);
        </li>
        <li>
          At a different date (defined as occurring within the
          [startDate](/schema/Cycle#startDate) and [endDate](/schema/Cycle#endDate) of the Cycle);
          or
        </li>
        <li>
          In a different [region](/schema/Site#region) or [country](/schema/Site#country).
        </li>
      </ul>
      Modelling or assumptions may have also been used to transform these data.
    </li>
    <li>
      <code>expert opinion</code> means the data have been estimated by experts in
      the field.
    </li>
    <li>
      <code>unsourced assumption</code> means the data do not have a clear source
      and/or are based on assumptions only.
    </li>
  </ul>
    */
    methodClassification?: PropertyMethodClassification;
    /**
    * A justification of the <code>[methodClassification](/schema/Property#methodClassification)</code> used. If the data were <code>estimated with assumptions</code> this field should also describe the assumptions. Not required but recommended if <code>[methodClassification](/schema/Property#methodClassification)</code> is specified.
    */
    methodClassificationDescription?: string;
    /**
    * A reference to the [Source](/schema/Source) of these data.
    */
    source?: Source;
    /**
    * An indicator of the data quality or whether the data are missing.
    */
    dataState?: PropertyDataState;
    /**
    * The version of the schema when these data were created.
    */
    schemaVersion?: string;
    /**
    * A list of fields that have been added to the original dataset.
    */
    added?: (string)[];
    /**
    * A list of versions of the model used to add these fields.
    */
    addedVersion?: (string)[];
    /**
    * A list of fields that have been updated on the original dataset.
    */
    updated?: (string)[];
    /**
    * A list of versions of the model used to update these fields.
    */
    updatedVersion?: (string)[];
    /**
    * A list of fields that have been 'aggregated' using data from multiple [Sites](/schema/Site) and [Cycles](/schema/Cycle).
    */
    aggregated?: (string)[];
    /**
    * A list of versions of the aggregation engine corresponding to each aggregated field.
    */
    aggregatedVersion?: (string)[];
}