Skip to content

Commit 7279e7d

Browse files
committed
add urls to table fields, re-phrase some sentences
1 parent 65ac663 commit 7279e7d

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

pages/faq.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ toc: true
66
---
77

88
{:id="bboxes"}
9-
## How to describe bounding boxes?
9+
## How to describe bounding boxes of detected objects?
1010

11-
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.
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.
1212

13-
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.
13+
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

1515
{:id="multiple-events"}
1616
## How to describe multiple events related to a single resource?
@@ -25,17 +25,18 @@ See the [github issue](https://github.com/tdwg/camtrap-dp/issues/328).
2525
{:id="non-animal"}
2626
## Can I describe plant or fungus observations using camtrap-dp?
2727

28-
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.
28+
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

3030
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

3535
There are two ways to include additional information (values not covered by the standard fields) in a camtrap-dp data package:
36-
- Using tags
3736

38-
Deployment and observation tables include `deploymentTags` and `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:
37+
### Using tags
38+
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:
3940

4041
deploymentID | deploymentTags
4142
--- | ---
@@ -44,10 +45,11 @@ dep2 | temperature:-5 | snow_cover:true
4445

4546
There are some drawbacks to using this method. Storing additional information in the media table is not possible, since it does not contain a tags field. Additionally, data represented this way is difficult to parse.
4647

47-
- Using a custom table
48+
### Using a custom table
49+
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:
4851

49-
A custom table can be added to the data package to store additional information. This requires providing a schema for the additional table. This schema has to contain the foreign key to the referenced table (`deploymentID`, `observationID` or `mediaID`) and the additional fields. This in an example schema for the deployment measurement table:
50-
```JSON
52+
```json
5153
{
5254
"name": "deployment-measurements",
5355
"title": "Deployment measurements",
@@ -96,26 +98,26 @@ A custom table can be added to the data package to store additional information.
9698
}
9799
```
98100

99-
The schema has to be added to the `datapackage.json` file in the `resources` field.
101+
The schema has to be added to the `datapackage.json` file in the [`resources`](/metadata/#resources) field.
100102

101-
This is an example table following the above schema:
103+
This is an example table following the schema above:
102104

103105
deploymentID | temperature | snowCover
104106
--- | --- | ---
105107
dep1 | 20 | false
106108
dep2 | -5 | true
107109

108-
We recommend this approach for storing additional information. It allows for easy parsing and merging of tables and is more flexible than using tags.
110+
We recommend this approach for storing additional information. It allows for easier parsing and merging of tables and is more flexible than using tags.
109111

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

112114

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

116-
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.
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.
117119

118-
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.
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.
119121

120-
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.
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.
121123

0 commit comments

Comments
 (0)