Skip to content

Commit

Permalink
added first 5 questions to the FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
kkuczkowska committed Dec 11, 2024
1 parent aa1c293 commit 6c4d303
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions pages/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,42 @@ SELECT * FROM table
## How do I do y

...

{:id="bboxes"}
## How to describe bounding boxes?

In camtrap-dp there are 4 terms used to describe bounding boxes: `bboxX`, `bboxY`, `bboxWidth` and `bboxHeight`. The values for all those fields are numbers between 0 and 1, relative to the image size.

The `bboxX` and `bboxY` fields are the coordinates of the top-left corner of the bounding box. `bboxX` is measured from the left side of the image and `bboxY` is measured from the top of the image. `bboxWidth` is measured from the left side of the bounding box to the right side of the bounding box. `bboxHeight` is measured from the top of the bounding box to the bottom of the bounding box.

{:id="multiple-events"}
## How to describe multiple events related to a single resource?

Multiple records in the observations table can reference the same media. See the [github issue](https://github.com/tdwg/camtrap-dp/issues/39).

{:id="multi-camera"}
## How to handle multi-camera deployments?

See the [github issue](https://github.com/tdwg/camtrap-dp/issues/328).

{:id="non-animal"}
## Can I describe plant or fungus observations using camtrap-dp?

Currently, possible values for the `observationType` field in the observations table are: `animal`, `human`, `vehicle`, `blank`, `unknown` and `unclassified`. This definition does not allow for observations of plants or fungi.

If you have a use case for describing non-animal observations using camtrap-dp, please let us know in [this github issue](https://github.com/tdwg/camtrap-dp/issues/346).

{:id="measurements"}
## How to include measurements in a data package?

todo

{:id="merge"}
## How to merge data packages describing different projects?

By design, a single camtrap-dp data package describes a single project. However, there are some use cases (for example a meta analysis), where merging multiple data packages could be helpful.

We provide an [R package](https://inbo.github.io/camtrapdp/) to read and manipulate camtrap-dp data packages. The R package contains the [merge function](https://inbo.github.io/camtrapdp/reference/merge_camtrapdp.html) that can be used to merge two data packages into one. The resulting data package is in valid camtrap-dp format and can be published.

Read the merge function documentation on how particular fields are merged in order to avoid loss of information. Please note that when merging x and y data packages, the `project$samplingDesign` field in the resulting package will be set to the value of `project$samplingDesign` from data package x. Because of that, we recommend only merging data packages for projects using the same sampling design.

0 comments on commit 6c4d303

Please sign in to comment.