-
Notifications
You must be signed in to change notification settings - Fork 15
Review transcript
| Lead | Do | Measure |
|---|---|---|
| Prep transcription package | Create a pull request to incorporate the data rescue into the repository | Expert Review: Does the pull request have the documentation identified below? Does the ReadMe render? |
Almost there! The final step in this data rescue is an expert review of the entire data package. Generally this is a fairly high level review looking for specific sections, formatting, and a working Level 0 read demo. It is possible (likely even) that when the data moves onto the harmonization phase that there will be additional issues that will need to be addressed.
To create a pull request.
First you will need to fork the main branch on the primary repository.
Then create a new branch on your fork for this specific rescue.
Upload the following files to that branch either via the web GUI or using a git push command.
Finally create a pull request on the primary repository asking for your branch to be merged into the main branch and let an expert reviewer know that it's ready for review!
You will need to include the following files:
- A ReadMe file with (qmd)
- A data transcription(s) include methods sections (csv, md)
- BibTex files (bib)
Reviewer checks should include the following:
- A qmd ReadMe file that renders without error with the following sections
- all contributors identified in the metadata
- human readable summary of data source with context for data rescue with citation
- A BibTex file with a single citation for the primary paper should be included as well using a AuthorYear bib key format with the first authors last name and year of publication.
- specific plan for fit-for-purpose data rescue
- a markdown read of the rescued text sections (generally Methods section)
- chunks that reproduce the tables/figures rescued and explain any deviation from the format in the article.
- a section that constructs the Level 0 data product
- Data transcription(s) that
- transcriptions of tables or x-y extracted data points from figures with fit for purpose information are csv (comma separated) format
- The first line should contain the caption and any footnotes
- The second line should be header information that reflects the table headers as much as possible or figure axis/labels
- There should be evidence of a cross check between two transcriptions that either includes a commented out section that uses a diff command to compare the two transcriptions or documentation as to why this was not done
- transcription of methods section with paired BibTex formatted reference
- methods section headers should be well formatted using
##or###as appropriate with an empty line above and below. - mathematics in the text should be well formatted LaTex using
$ ... $ - citations should be linked to a BibTex file using a AuthorYear bib key format with the first authors last name and year of publication.
- methods section headers should be well formatted using
- transcriptions of tables or x-y extracted data points from figures with fit for purpose information are csv (comma separated) format