CamtrapPackage
Defined in: camtrap/package/Package.ts:8
Camera Trap Data Package interface built on top of the TDWG specification
https://camtrap-dp.tdwg.org/metadata/
Extends
Section titled “Extends”Indexable
Section titled “Indexable”[key: `${string}:${string}`]: any
Properties
Section titled “Properties”$schema?
Section titled “$schema?”
optional$schema:string
Defined in: core/package/Package.ts:19
Package schema URL for validation
Inherited from
Section titled “Inherited from”bibliographicCitation?
Section titled “bibliographicCitation?”
optionalbibliographicCitation:string
Defined in: camtrap/package/Package.ts:130
Bibliographic citation for the dataset
contributors
Section titled “contributors”contributors:
CamtrapContributor[]
Defined in: camtrap/package/Package.ts:26
Contributors to the package
Required
Section titled “Required”Overrides
Section titled “Overrides”coordinatePrecision?
Section titled “coordinatePrecision?”
optionalcoordinatePrecision:number
Defined in: camtrap/package/Package.ts:125
Precision of geographic coordinates
created
Section titled “created”created:
string
Defined in: camtrap/package/Package.ts:20
Creation date of the package
Required
Section titled “Required”Format
Section titled “Format”ISO 8601
Overrides
Section titled “Overrides”description?
Section titled “description?”
optionaldescription:string
Defined in: core/package/Package.ts:29
A description of the package
Inherited from
Section titled “Inherited from”homepage?
Section titled “homepage?”
optionalhomepage:string
Defined in: core/package/Package.ts:34
A URL for the home page of the package
Inherited from
Section titled “Inherited from”image?
Section titled “image?”
optionalimage:string
Defined in: core/package/Package.ts:76
Package image
Inherited from
Section titled “Inherited from”keywords?
Section titled “keywords?”
optionalkeywords:string[]
Defined in: core/package/Package.ts:60
Keywords for the package
Inherited from
Section titled “Inherited from”licenses?
Section titled “licenses?”
optionallicenses:CamtrapLicense[]
Defined in: camtrap/package/Package.ts:141
Licenses for the package Extended with scope property
Overrides
Section titled “Overrides”
optionalname:string
Defined in: core/package/Package.ts:14
Unique package identifier Should use lowercase alphanumeric characters, periods, hyphens, and underscores
Inherited from
Section titled “Inherited from”profile
Section titled “profile”profile:
string
Defined in: camtrap/package/Package.ts:13
Package profile identifier
Required
Section titled “Required”project
Section titled “project”project:
object
Defined in: camtrap/package/Package.ts:32
Project metadata
acronym?
Section titled “acronym?”
optionalacronym:string
Project acronym
captureMethod
Section titled “captureMethod”captureMethod: (
"activityDetection"|"timeLapse")[]
Capture method used
Required
Section titled “Required”description?
Section titled “description?”
optionaldescription:string
Project description
optionalid:string
Project identifier
individualAnimals
Section titled “individualAnimals”individualAnimals:
boolean
Whether individual animals were identified
Required
Section titled “Required”observationLevel
Section titled “observationLevel”observationLevel: (
"media"|"event")[]
Level at which observations are recorded
Required
Section titled “Required”
optionalpath:string
Project URL or path
samplingDesign
Section titled “samplingDesign”samplingDesign:
"simpleRandom"|"systematicRandom"|"clusteredRandom"|"experimental"|"targeted"|"opportunistic"
Sampling design methodology
Required
Section titled “Required”title:
string
Project title
Required
Section titled “Required”Required
Section titled “Required”relatedIdentifiers?
Section titled “relatedIdentifiers?”
optionalrelatedIdentifiers:RelatedIdentifier[]
Defined in: camtrap/package/Package.ts:135
Related identifiers for the dataset
resources
Section titled “resources”resources:
Resource[]
Defined in: core/package/Package.ts:71
Data resources in this package (required)
Inherited from
Section titled “Inherited from”sources?
Section titled “sources?”
optionalsources:Source[]
Defined in: core/package/Package.ts:55
Data sources for this package
Inherited from
Section titled “Inherited from”spatial
Section titled “spatial”spatial:
GeoJSON
Defined in: camtrap/package/Package.ts:94
Spatial coverage of the data
Required
Section titled “Required”taxonomic
Section titled “taxonomic”taxonomic:
TaxonomicCoverage[]
Defined in: camtrap/package/Package.ts:120
Taxonomic coverage of the data
Required
Section titled “Required”temporal
Section titled “temporal”temporal:
object
Defined in: camtrap/package/Package.ts:100
Temporal coverage of the data
end:
string
End date of temporal coverage
Required
Section titled “Required”Format
Section titled “Format”ISO 8601
start:
string
Start date of temporal coverage
Required
Section titled “Required”Format
Section titled “Format”ISO 8601
Required
Section titled “Required”title?
Section titled “title?”
optionaltitle:string
Defined in: core/package/Package.ts:24
Human-readable title
Inherited from
Section titled “Inherited from”version?
Section titled “version?”
optionalversion:string
Defined in: core/package/Package.ts:40
Version of the package using SemVer
Example
Section titled “Example”"1.0.0"