Skip to content

Commit

Permalink
Update dataset-name.md
Browse files Browse the repository at this point in the history
  • Loading branch information
timvdstap authored Jan 10, 2025
1 parent 0add78b commit f44f1f0
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions firebase-functions/functions/dataset-name.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Best Practices Checklist

### In General
### Start

- [ ] No previous versions of this metadata record exist (eg for earlier versions of the data, if so update that record rather than creating a new one)

Expand All @@ -9,12 +9,11 @@
#### Dataset title:

- [ ] No version information in the title
- [ ] Frontloaded (with the most important information first)
- [ ] Include the geographical region the data apply to
- [ ] Short – aim for 60 characters including spaces
- [ ] Does not include acronyms – put these in the keywords
- [ ] Does not include the word “dataset”
- [ ] Time series datasets should include “time series” at the end of the title

### Resource Identification

#### Abstract

Expand All @@ -31,6 +30,7 @@
### Spatial

- [ ] Ensure that Depth or Height Positive is correctly selected
- [ ] For Biological records a description of geographic extent is provided

### Contact

Expand All @@ -41,11 +41,11 @@
- [ ] Add contact affiliation where known including ROR
- [ ] If resource is (partially) generated by Hakai researchers, include 'Tula Foundation' (with associated ROR) with 'Funder' role. Be sure to uncheck 'include in citation' for Tula Foundation.

### Resources
### Data and Documentation

- [ ] Resource links go to specific dataset download (not generic platform like waterproperties.ca)
- [ ] Readme, changelog, data dictionary, protocols included in data-package (for tabular text based data)
- [ ] An archive folder, or other means, for older data versions is included in the data package if the version is _not_ 1.0
- [ ] Resource links go to specific dataset or data package (not generic platform like waterproperties.ca)
- [ ] Readme, changelog, data dictionary, protocols included in data package (for tabular text based data)
- [ ] An archive folder, or other means, for older data versions is included if previous versions exist
- [ ] Links work
- [ ] All files in the data package can be opened and are not corrupt
- [ ] No executable files in the data package. Files should be open formats and standards (.csv, .txt for example)

0 comments on commit f44f1f0

Please sign in to comment.