Skip to content

Commit 0730d10

Browse files
committed
add data reporting section to readme
1 parent fb95640 commit 0730d10

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,18 @@ All trait and yield data include a quality control flag:
109109
| `0` | Unchecked | Not yet reviewed |
110110
| `-1` | Flagged | Identified as incorrect (excluded from this package) |
111111

112-
This package exports only `checked >= 0` data. Flagged records (`checked = -1`) are excluded during data preparation. All data in this package is public (from BETYdb records with `access_level = 4`). For restricted or flagged data, access the BETYdb PostgreSQL database directly.
112+
This package exports only `checked >= 0` data. Flagged records (`checked = -1`) are excluded during data preparation. Records with `checked = NA` are converted to `checked = 0` (unchecked) during the build. All data in this package is public (from BETYdb records with `access_level = 4`). For restricted or flagged data, access the BETYdb PostgreSQL database directly.
113+
114+
---
115+
116+
## Reporting Data Issues
117+
118+
If you find errors in the data or want to report verified records:
119+
120+
- **Data corrections:** [File a data correction issue](https://github.com/PecanProject/betydata/issues/new?template=data_correction.md)
121+
- **Verified records:** [Report a verified record](https://github.com/PecanProject/betydata/issues/new?template=verified_record.md)
122+
123+
To submit corrections via pull request, edit the relevant CSV file in `data-raw/csv/`, rebuild with `source("data-raw/make-data.R")`, and submit a PR using the data correction template.
113124

114125
---
115126

@@ -148,16 +159,6 @@ Lazy-loaded R data objects, available after `library(betydata)`:
148159
traitsview
149160
```
150161

151-
### Parquet (Alternative)
152-
153-
For use with Arrow/DuckDB or cross-platform workflows:
154-
```r
155-
library(arrow)
156-
traitsview <- read_parquet(
157-
system.file("extdata/parquet/traitsview.parquet", package = "betydata")
158-
)
159-
```
160-
161162
### Frictionless Data Package
162163

163164
Machine-readable metadata following the Frictionless data standard:

0 commit comments

Comments
 (0)