|
29 | 29 | file. The csv file follows the format of the knowledge-base reagent_resources.csv, with the following differences: |
30 | 30 | 1. Each row is expected to contain a single ORCID, either in the Agree or Disagree column. # noqa W291 |
31 | 31 | 2. Two additional columns, "Publications" and "Notes". The "Notes" column is free text and can include markdown formatting. |
32 | | -The "Publications" column contains the prefixes of markdown files that contain the publication information. If multiple |
| 32 | +The "Publications" column contains the prefixes of markdown files that contain the publication information. If multiple |
33 | 33 | publications are associated with the same row, they are separated by a semicolon. These files are expected to be in the |
34 | 34 | same directory as the csv input file. |
35 | 35 |
|
36 | 36 | Example entry for "Publications" column:"radtke_pnas;radtke_nat_prot", corresponding markdown files are |
37 | 37 | radtke_pnas.md and radtke_nat_prot.md. |
38 | 38 |
|
39 | | -All supporting materials files follow the same structure which is defined by a template file. Generally speaking, |
| 39 | +All supporting materials files follow the same structure which is defined by a template file. Generally speaking, |
40 | 40 | template based file generation is best done using a dedicated tool such as jinja (https://jinja.palletsprojects.com/). |
41 | | -As our use case is very simple, string formatting is sufficient and we avoid dependency on an additional tool. |
| 41 | +As our use case is very simple, string formatting is sufficient and we avoid dependency on an additional tool. |
42 | 42 |
|
43 | 43 | The supporting material files are created with the expected names in the specific directory: target_conjugate/orcid.md. |
44 | 44 |
|
45 | 45 | NOTE: This script is intended for initial creation of supporting material files. If the file target_conjugate/orcid.md |
46 | 46 | already exists, DO NOT use the same directory for output. Instead, provide a temporary directory for output. You |
47 | 47 | then need to reconcile the newly created file(s) with the existing one(s). The numbering of the publications |
48 | | -and notes need to be updated when the new file content is added to the existing content and the configuration |
| 48 | +and notes need to be updated when the new file content is added to the existing content and the configuration |
49 | 49 | table needs to be updated too. This is a MANUAL step. |
50 | 50 | """ |
51 | 51 |
|
|
0 commit comments