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

HESTIA Schema

import { JSON, SchemaType } from './types';
/**
 * How complete the data describing the [Inputs](/schema/Input), [Products](/schema/Product), [Animals](/schema/Animal), and key [Practices](/schema/Practice) are. Each field in Completeness corresponds to one or more <code>[termTypes](/schema/Term#termType)</code> in the Glossary. If an area is marked complete, this means that the types and quantities of all the items within the <code>termType(s)</code> covered by the Completeness area are recorded and if they are not recorded, this means they were not present. Use of all data in the HESTIA format must therefore be interpreted in light of completeness: if completeness is <code>true</code> for a <code>termType</code>, but no data are provided for a term in that <code>termType</code>, that means the quantity of that item was zero. For quantity, completeness can be marked as <code>true</code> if either the total quantity is provided or both the minimum and maximum are provided.
 */
export declare class Completeness extends JSON<SchemaType.Completeness> {
    /**
    * <table class="sub-table w-100">   <tbody>
       <tr>
         <td class="w-100"> The types and quantities of all animal feed
           used during the [Cycle](/schema/Cycle), including hay and silage, are specified.
           Note that fresh forage has its own completeness field. </td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No animal feed was used during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Animal feed was used during the Cycle,
           but the types and quantities are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    animalFeed?: boolean;
    /**
    * <table class="sub-table w-100">   <tbody>
       <tr>
         <td class="w-100">The types and quantities of all
           [live animals](/glossary?termType=liveAnimal) or
           [live aquatic species](/glossary?termType=liveAquaticSpecies)
           that were present during the Cycle are specified in the [animal](/schema/Animal) node.
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No live animals were present during Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Live animals were present during the Cycle,
           but the types and quantities are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    animalPopulation?: boolean;
    /**
    * <table class="sub-table w-100">  <tbody>
      <tr>
        <td class="w-100">
        The quantity of above and below ground
         [crop residue](/glossary?termType=cropResidue) created
         and its [management](/glossary?termType=cropResidueManagement) are recorded.</td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">No crop residue was created or managed during the Cycle.</td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">Crop residue was created during the Cycle,
          but the quantities and management are not fully recorded.</td>
        <td class="sub-table-value">Set to <code>false</code></td>
      </tr>
    </tbody>
  </table>
    */
    cropResidue?: boolean;
    /**
    * <table class="sub-table w-100">   <tbody>
       <tr>
         <td class="w-100">The types and quantities of all [electricity](/glossary?termType=electricity) and
           [fuel](/glossary?termType=fuel) used during the [Cycle](/schema/Cycle),
           excluding during the transport phase, are recorded.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Electricity and fuel were not used during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Electricity and/or fuel were used during the Cycle,
           but the types and quantities are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    electricityFuel?: boolean;
    /**
    * <table class="sub-table w-100">  <tbody>
      <tr>
        <td class="w-100">The types and quantities of [excreta](/glossary?termType=excreta) created
          and its [management](/glossary?termType=excretaManagement) are specified.
        </td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">No excreta was created or managed during the Cycle.</td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">Excreta was created during the Cycle,
          but the quantities and management are not fully recorded.</td>
        <td class="sub-table-value">Set to <code>false</code></td>
      </tr>
    </tbody>
  </table>
    */
    excreta?: boolean;
    /**
    * <table class="sub-table w-100">   <tbody>
       <tr>
         <td class="w-100">The types and quantities of all
           [organic fertiliser](/glossary?termType=organicFertiliser) and
           [inorganic fertiliser](/glossary?termType=inorganicFertiliser),
           or the quantity of each [fertiliser brand name](/glossary?termType=fertiliserBrandName),
           used during the [Cycle](/schema/Cycle) are recorded.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No fertilisers were used during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Fertilisers were used during the Cycle,
           but the types and quantities are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    fertiliser?: boolean;
    /**
    * <table class="sub-table w-100">   <tbody>
       <tr>
         <td class="w-100"> The types and quantities of all [fresh forage](/glossary?termType=forage)
           fed to, or grazed by, animals during the Cycle are recorded.
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No fresh forage was consumed during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Fresh forage was consumed during the Cycle,
           but the types and quantities are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    freshForage?: boolean;
    /**
    * <table class="sub-table w-100">  <tbody>
      <tr>
        <td class="w-100">For feed or food processing Cycles, the type and quantities of all
           feed or food ingredients used, such as [crop products](/glossary?termType=crop),
           [animal products](/glossary?termType=animalProduct),
           [processed foods](/glossary?termType=processedFood),
           and/or [feed or food additives](/glossary?termType=feedFoodAdditive) are recorded.
        </td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">No feed or food ingredients were used during the Cycle.</td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">Food or feed ingredients were used during the Cycle,
           but the types and quantities are not fully recorded.</td>
        <td class="sub-table-value">Set to <code>false</code></td>
      </tr>
    </tbody>
  </table>
    */
    ingredient?: boolean;
    /**
    * <table class="sub-table w-100">   <tbody>
       <tr>
         <td class="w-100">The types and quantities of all
           [live animals](/glossary?termType=liveAnimal) or
           [live aquatic species](/glossary?termType=liveAquaticSpecies)
           which were Inputs into the Cycle are specified. For example,
           [piglets](/glossary?termType=piglet) might be an Input into a pig
           fattening Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No live animals were Inputs into the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Live animals were Inputs into the Cycle,
           but the types and quantities are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    liveAnimalInput?: boolean;
    /**
    * <table class="sub-table w-100">   <tbody>
       <tr>
         <td class="w-100">The types and quantities of all [material](/glossary?termType=material)
           and [substrate](/glossary?termType=substrate) Inputs, which includes capital
           equipment depreciated over the [Cycle](/schema/Cycle), are recorded.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No material inputs were used during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Material inputs were used during the Cycle,
           but the types and quantities are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    material?: boolean;
    /**
    * <table class="sub-table w-100">   <tbody>
       <tr>
         <td class="w-100">The types of all mechanical [operation](/glossary?termType=operation)
           performed during the [Cycle](/schema/Cycle) and either their duration or
           the percentage of area they covered are recorded.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No mechanical operations were performed during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Mechanical operations were performed during the Cycle,
           but the types and quantities are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    operation?: boolean;
    /**
    * <table class="sub-table w-100">   <tbody>
       <tr>
         <td class="w-100">The types and quantities of all other chemicals (including
           [processing aids](/glossary?termType=processingAid),
           [other inorganic chemicals](/glossary?termType=otherInorganicChemical), and
           [other organic chemicals](/glossary?termType=otherOrganicChemical)) used during
           the [Cycle](/schema/Cycle) are recorded.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No processing aids or other chemicals were used during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Processing aids and/or other chemicals were used during the Cycle,
           but the types and quantities are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    otherChemical?: boolean;
    /**
    * <table class="sub-table w-100">   <tbody>
       <tr>
         <td class="w-100">The types and quantities of all pesticides (either as
           [active ingredients](/glossary?termType=pesticideAI)
           or [brand names](/glossary?termType=pesticideBrandName)) and
           [veterinary drugs](/glossary?termType=veterinaryDrug) used during
           the [Cycle](/schema/Cycle) are recorded.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No pesticides or veterinary drugs were used during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Pesticides and/or veterinary drugs were used during the Cycle,
           but the types and quantities are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    pesticideVeterinaryDrug?: boolean;
    /**
    * <table class="sub-table w-100">  <tbody>
      <tr>
        <td class="w-100">The types and quantities of all
          [crop](/glossary?termType=crop),
          [live animal](/glossary?termType=liveAnimal),
          [live aquatic species](/glossary?termType=liveAquaticSpecies),
          [animal product](/glossary?termType=animalProduct), and
          [processed food](/glossary?termType=processedFood)
          produced during the [Cycle](/schema/Cycle) are recorded. In the case where
          Products were intended to be produced but no production occurred (e.g., if crops
          fail due to disease) the types of products should still be recorded and the
          quantity set to zero.
        </td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">No Products were produced (or intended to be produced) during the Cycle.</td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">Products were produced during the Cycle,
           but the types and quantities are not fully recorded.</td>
        <td class="sub-table-value">Set to <code>false</code></td>
      </tr>
    </tbody>
  </table>
    */
    product?: boolean;
    /**
    * <table class="sub-table w-100">  <tbody>
      <tr>
        <td class="w-100">The types and quantities of all [seed](/glossary?termType=seed) Inputs,
         such as [seed](/term/seed),[saplings](/term/saplings), or [semen](/term/semen) are recorded.</td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">No seed Inputs were used during the Cycle.</td>
        <td class="sub-table-value">Set to <code>true</code></td>
      </tr>
      <tr>
        <td class="w-100">Seed Inputs were used during the Cycle,
           but the types and quantities are not fully recorded.</td>
        <td class="sub-table-value">Set to <code>false</code></td>
      </tr>
    </tbody>
  </table>
    */
    seed?: boolean;
    /**
    * <table class="sub-table w-100">   <tbody>
       <tr>
         <td class="w-100">The types and quantities of all
           [soil amendments](/glossary?termType=soilAmendment) and
           [biochar](/glossary?termType=biochar) used
           during the [Cycle](/schema/Cycle) are recorded.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No soil amendments were used during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Soil amendments were used during the Cycle,
           but the types and quantities are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    soilAmendment?: boolean;
    /**
    * <table class="sub-table w-100">   <tbody>
       <tr>
         <td class="w-100">The [transport modes](/glossary?termType=transport) and distances
           for each [Input](/schema/Input) to the [Site](/schema/Site) are recorded.
           If [Products](/schema/Product) were also Transported during this Cycle, the distances
           and modes are specified.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No Inputs were transported to the Site and
           no Products were transported during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Inputs and/or Products were transported, but data on the
         [modes](/glossary?termType=transport) and distances are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    transport?: boolean;
    /**
    * <table class="sub-table w-100">   <tbody>
       <tr>
         <td class="w-100">The types and quantities all [waste](/glossary?termType=waste) streams,
           their and [management](/glossary?termType=wasteManagement), and their transport to where
           they are managed are specified (note that [crop residue](/schema/Completeness#cropResidue)
           and [excreta](/schema/Completeness#excreta) waste streams and management have their own
           completeness fields).
           Examples of waste streams include dead animals or plastic films for greenhouses.
           Examples of management include disposal into a water body or bio-digestion.
           Examples of transport include taking waste to a disposal center.
          </td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No waste streams were created or managed during the Cycle.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Waste was created or managed during the Cycle,
           but the types and quantities are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    waste?: boolean;
    /**
    * <table class="sub-table w-100">   <tbody>
       <tr>
         <td class="w-100">The types and quantities of all [water](/glossary?termType=water) used
           during the [Cycle](/schema/Cycle) are recorded.</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">No water was used during the Cycle or only very small quantities
           were used but not recorded (e.g., water mixed with fertilisers or pesticides
           for spraying).</td>
         <td class="sub-table-value">Set to <code>true</code></td>
       </tr>
       <tr>
         <td class="w-100">Water was used during the Cycle,
           but the types and quantities are not fully recorded.</td>
         <td class="sub-table-value">Set to <code>false</code></td>
       </tr>
     </tbody>
   </table>
    */
    water?: boolean;
    /**
    * 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)[];
}