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

HESTIA Schema

import { JSON, SchemaType } from './types';
import { Term } from './Term';
import { Source } from './Source';
import { Property } from './Property';
import { TermTermType } from './Term';
export declare enum ManagementStatsDefinition {
    animals = "animals",
    cycles = "cycles",
    impactAssessments = "impactAssessments",
    modelled = "modelled",
    'other observations' = "other observations",
    regions = "regions",
    replications = "replications",
    simulated = "simulated",
    sites = "sites",
    spatial = "spatial",
    time = "time"
}
export declare enum ManagementMethodClassification {
    '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"
}
/**
 * Contains all the TermTermType with override on the Management.
 * Note: it does not contain the default TermTermType on related Blank Nodes.
 */
export declare const managementTermTermType: {
    term: TermTermType[];
    all: TermTermType[];
};
/**
 * Contains all the fields that make the blank nodes unique.
 */
export declare const managementUniquenessFields: {
    properties: string[];
};
/**
 * The historical, current, and future management of a [Site](/schema/Site). Used to represent land use and land cover history, crop rotations, aquaculture rotations, and historical and future production practices. Each Management blank node must be unique, and the fields which determine uniqueness are defined in the <code>[management](/schema/Site#management)</code> field of the Site.
 */
export declare class Management extends JSON<SchemaType.Management> {
    /**
    * A reference to the [Term](/schema/Term) describing the Site Management.
    */
    term?: Term;
    /**
    * A description of the Management.
    */
    description?: string;
    /**
    * The value associated with the Management [Term](/schema/Management#term).
    */
    value?: number | boolean;
    /**
    * An array of up to 1000 random samples from the posterior distribution of <code>[value](/schema/Management#value)</code. This should describe the entire distribution of the dataset and not the distribution of the mean.
    */
    distribution?: (number)[];
    /**
    * The standard deviation of <code>[value](/schema/Management#value)</code>.
    */
    sd?: number;
    /**
    * The minimum of <code>[value](/schema/Management#value)</code>.
    */
    min?: number;
    /**
    * The maximum of <code>[value](/schema/Management#value)</code>.
    */
    max?: number;
    /**
    * What the descriptive statistics (<code>[sd](/schema/Management#sd)</code>, <code>[min](/schema/Management#min)</code>, <code>[max](/schema/Management#max)</code>, and <code>[value](/schema/Management#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?: ManagementStatsDefinition;
    /**
    * The number of observations the descriptive statistics are calculated over.
    */
    observations?: number;
    /**
    * The start date of this Site Management in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
    */
    startDate?: string;
    /**
    * The end date of this Site Management in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD, YYYY-MM, or YYYY).
    */
    endDate?: string;
    /**
    * A classification of the method used to acquire or estimate the <code>[term](/schema/Management#term)</code> and <code>[percentArea](/schema/Management#percentArea)</code>. Overrides the <code>[defaultMethodClassification](/schema/Site#defaultMethodClassification)</code> specified in the [Site](/schema/Site). <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?: ManagementMethodClassification;
    /**
    * A justification of the <code>[methodClassification](/schema/Management#methodClassification)</code> used. If the data were <code>estimated with assumptions</code> this field should also describe the assumptions. This is a required field if <code>[methodClassification](/schema/Management#methodClassification)</code> is specified.
    */
    methodClassificationDescription?: string;
    /**
    * A reference to the [Term](/schema/Term) describing the [model](/glossary?termType=model) used to estimate these data.
    */
    model?: Term;
    /**
    * A free text field, describing the model used to estimate these data.
    */
    modelDescription?: string;
    /**
    * A reference to the [Source](/schema/Source) of these data, if different from the defaultSource of the [Cycle](/schema/Cycle) or [Site](/schema/Site).
    */
    source?: Source;
    /**
    * A list of references to any other [sources](/schema/Source) of these data.
    */
    otherSources?: Source[];
    /**
    * A list of [Properties](/schema/Property) which can be assigned to the Management [Term](/schema/Management#term).
    */
    properties?: Property[];
    /**
    * 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).
    */
    aggregated?: (string)[];
    /**
    * A list of versions of the aggregation engine corresponding to each aggregated field.
    */
    aggregatedVersion?: (string)[];
}