Skip to content

Commit b48329c

Browse files
authored
Merge pull request #1007 from Sage-Bionetworks/develop-update-ReadMeConfigSection
Emphasize that users should download the `config.yml` from develop branch in ReadMe
2 parents 47768cf + 66f8fc6 commit b48329c

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ This command will install the dependencies based on what we specify in poetry.lo
7474
5. Fill in credential files:
7575
*Note*: If you won't interact with Synapse, please ignore this section.
7676

77-
There are two main configuration files that need to be edited :
77+
There are two main configuration files that need to be edited:
7878
[config.yml](https://github.com/Sage-Bionetworks/schematic/blob/develop/config.yml)
7979
and [synapseConfig](https://raw.githubusercontent.com/Sage-Bionetworks/synapsePythonClient/v2.3.0-rc/synapseclient/.synapseConfig)
8080

@@ -88,6 +88,8 @@ editor of your choice and edit the `username` and `authtoken` attribute under th
8888
8989
<strong>Configure config.yml File</strong>
9090

91+
*Note*: Below is only a brief explanation of some attributes in `config.yml`. <strong>Please use the link [here](https://github.com/Sage-Bionetworks/schematic/blob/develop/config.yml) to get the latest version of `config.yml` in `develop` branch</strong>.
92+
9193
Description of `config.yml` attributes
9294

9395
definitions:
@@ -104,16 +106,28 @@ Description of `config.yml` attributes
104106
service_acct_creds: "syn25171627" # synapse ID of service_account_creds.json file
105107

106108
manifest:
107-
title: "Patient Manifest " # title of metadata manifest file
108-
data_type: "Patient" # component or data type from the data model
109+
title: "example" # title of metadata manifest file
110+
# to make all manifests enter only 'all manifests'
111+
data_type:
112+
- "Biospecimen"
113+
- "Patient"
109114

110115
model:
111116
input:
112117
location: "data/schema_org_schemas/example.jsonld" # path to JSON-LD data model
113118
file_type: "local" # only type "local" is supported currently
114-
validation_schema: "~/path/to/validation_schema.json" # path to custom JSON Validation Schema JSON file
115-
log_location: "~/path/to/log_folder/validation_schema.json" # auto-generated JSON Validation Schemas can be logged
116-
119+
style: # configuration of google sheet
120+
google_manifest:
121+
req_bg_color:
122+
red: 0.9215
123+
green: 0.9725
124+
blue: 0.9803
125+
opt_bg_color:
126+
red: 1.0
127+
green: 1.0
128+
blue: 0.9019
129+
master_template_id: '1LYS5qE4nV9jzcYw5sXwCza25slDfRA1CIg3cs-hCdpU'
130+
strict_validation: true
117131

118132
*Note*: Paths can be specified relative to the `config.yml` file or as absolute paths.
119133

0 commit comments

Comments
 (0)