Skip to content

Commit d2d6013

Browse files
authored
Merge pull request #411 from tdwg/update-faq
Update faq.md
2 parents 3dba8af + 7da88b6 commit d2d6013

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

pages/faq.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ toc: true
88
{:id="bboxes"}
99
## How to describe bounding boxes of detected objects?
1010

11-
In Camtrap DP, in the [observations](/data/#observations) table there are four terms used to describe bounding boxes: [`bboxX`](/data/#observations.bboxX), [`bboxY`](/data/#observations.bboxY), [`bboxWidth`](/data/#observations.bboxWidth), and [`bboxHeight`](/data/#observations.bboxHeight). The values for all these fields are numbers between 0 and 1, relative to the image size.
11+
In the [observations](/data/#observations) table there are four terms used to describe bounding boxes: [`bboxX`](/data/#observations.bboxX), [`bboxY`](/data/#observations.bboxY), [`bboxWidth`](/data/#observations.bboxWidth), and [`bboxHeight`](/data/#observations.bboxHeight). The values for all these fields are numbers between 0 and 1, relative to the image size.
1212

1313
The `bboxX` and `bboxY` fields represent the coordinates of the top-left corner of the bounding box. `bboxX` is measured from the left edge of the image, while `bboxY` is measured from the top edge. `bboxWidth` represents the width of the bounding box, measured from its left edge to its right edge. Similarly, `bboxHeight` represents the height of the bounding box, measured from its top edge to its bottom edge.
1414

@@ -23,20 +23,20 @@ Multiple records in the observations table can reference the same media. See [th
2323
See [this GitHub issue](https://github.com/tdwg/camtrap-dp/issues/328).
2424

2525
{:id="non-animal"}
26-
## Can I describe plant or fungus observations using camtrap-dp?
26+
## Can I describe plant or fungus observations using Camtrap DP?
2727

2828
Currently, possible values for the [`observationType`](/data/#observations.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.
2929

30-
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).
30+
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).
3131

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

35-
There are two ways to include additional information (values not covered by the standard fields) in a camtrap-dp data package:
35+
There are two ways to include additional information (values not covered by the standard fields) in a Camtrap DP:
3636

3737
### Using tags
3838

39-
Deployment and observation tables include [`deploymentTags`](/data/#deployments.deploymentTags) and [`observationTags`](/data/#observations.observationTags) fields. These fields can be used to store additional information as pipe-delimited key:value pairs. For example, this is how temperature and snow cover information could be represented in the deployment table:
39+
Deployment and observation tables include [`deploymentTags`](/data/#deployments.deploymentTags) and [`observationTags`](/data/#observations.observationTags) fields. You can use these fields to store additional information as key:value pairs, separated by a pipe character (|). For example, this is how temperature and snow cover information could be represented in the deployment table:
4040

4141
deploymentID | deploymentTags
4242
--- | ---
@@ -47,7 +47,7 @@ There are some drawbacks to using this method. Storing additional information in
4747

4848
### Using a custom table
4949

50-
A custom table can be added to the data package to store additional information. This requires providing a schema for the additional table. The schema must include a foreign key to the referenced table ([`deploymentID`](/data/#deployments.deploymentID), [`observationID`](/data/#observations.observationID), or [`mediaID`](/data/#media.mediaID)) and the additional fields. Here is an example schema for the deployment measurement table:
50+
You can add a custom table to the data package to store additional information. This requires providing a schema for the additional table. The schema must include a foreign key to the referenced table ([`deploymentID`](/data/#deployments.deploymentID), [`observationID`](/data/#observations.observationID), or [`mediaID`](/data/#media.mediaID)) and the additional fields. Here is an example schema for the deployment measurement table:
5151

5252
```json
5353
{
@@ -98,7 +98,7 @@ A custom table can be added to the data package to store additional information.
9898
}
9999
```
100100

101-
The schema has to be added to the `datapackage.json` file in the [`resources`](/metadata/#resources) field.
101+
You need to add this table to the `datapackage.json` file in the [`resources`](/metadata/#resources) field.
102102

103103
This is an example table following the schema above:
104104

@@ -111,13 +111,12 @@ We recommend this approach for storing additional information. It allows for eas
111111

112112
For more details, see [this GitHub issue](https://github.com/tdwg/camtrap-dp/issues/358).
113113

114-
115114
{:id="merge"}
116115
## How to merge data packages describing different projects?
117116

118-
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 beneficial.
117+
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 beneficial.
119118

120-
We provide an [R package](https://inbo.github.io/camtrapdp/) to read and manipulate camtrap-dp data packages. The R package includes the [merge function](https://inbo.github.io/camtrapdp/reference/merge_camtrapdp.html), which can be used to merge two data packages into one. The resulting data package will be in a valid camtrap-dp format and can be published.
119+
We provide an [R package](https://inbo.github.io/camtrapdp/) to read and manipulate Camtrap DP. The R package includes the [merge function](https://inbo.github.io/camtrapdp/reference/merge_camtrapdp.html) that lets you combine two data packages into a single valid Camtrap DP.
121120

122-
Refer to the merge function documentation to understand how specific fields are merged to avoid information loss. Please note that when merging data packages x and y, the [`project$samplingDesign`](/metadata/#project.samplingDesign) field in the resulting package will be set to the value of `project$samplingDesign` from data package x. Therefore, we recommend merging data packages only for projects that use the same sampling design.
121+
Consult the merge function documentation to understand exactly how specific fields are merged to avoid information loss. Please note that when merging data packages x and y, the [`project$samplingDesign`](/metadata/#project.samplingDesign) field in the resulting package will be set to the value of `project$samplingDesign` from data package x. Therefore, we recommend merging data packages only for projects that use the same sampling design.
123122

0 commit comments

Comments
 (0)