Skip to content

Commit 01e5369

Browse files
committed
Add documentation about providing janno files to minotaur-recipes
1 parent 3a41e2b commit 01e5369

File tree

1 file changed

+45
-1
lines changed

1 file changed

+45
-1
lines changed

minotaur.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,51 @@ git push
9090

9191
Once again, replacing `<PACKAGE_NAME>` with the name of the package recipe you are adding. If you refresh your branch on GitHub you should now see the SSF file you created.
9292

93-
### 5. Open a Pull Request(PR) to the minotaur-recipes repository
93+
### 5. (Recommended) Prepare a janno file with relevant metadata
94+
95+
?> If the package recipe you are preparing already exists in the [Poseidon Community Archive (PCA)](https://github.com/poseidon-framework/community-archive), then you can skip this step.
96+
97+
While a janno file is not technically required for Minotaur, we always prioritise processing of package requests that include a janno file.
98+
To ensure your request is processed without delays and the resulting package becomes available quickly on the PMA, we recommend providing a janno file with the package recipe.
99+
This janno file should contain information on the following janno columns, that are not dependent on the data processing, and hence not filled automatically by Minotaur.
100+
One row should be present in the prepared janno file for each `poseidon_ids` specified in the SSF file.
101+
The `Poseidon_ID` column of the prepared janno should match those specified in the SSF file of the recipe
102+
(e.g. if one row in the SSF file was assigned a `poseidon_ids` value of `ind001;ind001_SG`, that corresponds to two rows in the janno file, with `Poseidon_ID`s of `ind001` and `ind001_SG` respectively).
103+
104+
The prepared janno file should include information for as many of the following columns as possible:
105+
106+
- Genetic_Sex
107+
- Group_Name
108+
- Alternative_IDs
109+
- Relation_To
110+
- Relation_Degree
111+
- Relation_Type
112+
- Relation_Note
113+
- Collection_ID
114+
- Country
115+
- Country_ISO
116+
- Location
117+
- Site
118+
- Latitude
119+
- Longitude
120+
- Date_Type
121+
- Date_C14_Labnr
122+
- Date_C14_Uncal_BP
123+
- Date_C14_Uncal_BP_Err
124+
- Date_BC_AD_Start
125+
- Date_BC_AD_Median
126+
- Date_BC_AD_Stop
127+
- Date_Note
128+
- MT_Haplogroup
129+
- Y_Haplogroup
130+
- Source_Tissue
131+
- Primary_Contact
132+
- Note
133+
- Keywords
134+
135+
All other standard janno columns are filled by Minotaur, and will be overwritten if provided.
136+
137+
### 6. Open a Pull Request(PR) to the minotaur-recipes repository
94138

95139
Go to the [*Pull Requests* tab of the minotaur-recipes repository](https://github.com/poseidon-framework/minotaur-recipes/pulls) on GitHub, and click on the *New Pull Request* button.
96140

0 commit comments

Comments
 (0)