Skip to content

Commit

Permalink
Sync README.md with prod
Browse files Browse the repository at this point in the history
Signed-off-by: Anthony Williams <[email protected]>
  • Loading branch information
afwillia authored Dec 18, 2024
1 parent 49d859f commit 887afd8
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Project configurations for the [Data Curator App](github.com/sage-Bionetworks/data_curator)

This repo contains DCC configurations for the Sage-hosted multi-tenant Data Curator App. The prod and staging branches configure their respective version of the app. To contribute, fork the repo and create PRs into the staging or prod branch, depending on which app you want to update. The staging and prod branches are maintained separately; they have diverged and are not intended to be merged, so make sure to start changes from the desired branch.

The file [tenants.json](tenants.json) controls which DCCs appear in DCA. It contains a json object `tenants` which holds one json object per DCC. Each DCC object requires:

- `name`: The name of the DCC to appear in the DCA selection menu
Expand Down Expand Up @@ -41,19 +43,21 @@ Each DCC will have its own directory to store configuration files. At minimum it
- `model_validate`

- `restrict_rules`: `TRUE` or `FALSE`. [Schematic model validate and submit option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-validate).
- `enable_cross_manifest_validation`: `TRUE` or `FALSE`. Use cross manifest validation.

- `model_submit`

- `table_column_names`: `class_label`, `display_label`, or `display_name` [Schema labelling option](https://sagebionetworks.jira.com/wiki/spaces/SCHEM/pages/3089498257/How+to+Define+Display+Name+Labeling)
- `annotation_keys`: `class_label` or `display_label` [Schema labelling option](https://sagebionetworks.jira.com/wiki/spaces/SCHEM/pages/3089498257/How+to+Define+Display+Name+Labeling)
- `table_manipulation`: `replace` or `upsert`. [Schematic model submit option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-submit).
- `manifest_record_type`: One of `table_and_file`, `file_only` , `file_and_entities` or `table_file_and_entities`. [Schematic model submit option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-submit).
- `hide_blanks`: `TRUE` or `FALSE`. [Schematic model submit option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-submit).
- `hide_blanks`: `TRUE` or `FALSE`. [Schematic model submit option for blank annotations](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-submit).
- `file_annotations_upload`: `TRUE` or `FALSE`. Annotate associated files/entities with values in the manifest. [Schematic model submit option](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-submit).

Each DCC also needs a template configuration file. This controls which data types are accessible to users and if they contain record-based or file-based data. It can be generated by hand or automatically from a data model using the [dca-template-config-action github action](https://github.com/Sage-Bionetworks/dca-template-config-action). See an [example workflow in a data model repo](https://github.com/Sage-Bionetworks/data-models/blob/main/.github/workflows/create-template-config.yml). This json file can be validated against [schemas/dca_template_config.schema.json](schemas/dca_template_config.schema.json). The top level of the file needs a json array of objects named `manifest_schemas`. Each object in the array requires the strings:

- `display_name`: Display name of the data type
- `schema_name`: Name of the schema
- `type`: record or file
- `type`: record or file. If the manifest has Filename as a column, type should be file. When annotating records inside a spreadsheet-like file, such as specimen or patient information, type should be record.

See our [example dca_template_config.json](https://github.com/Sage-Bionetworks/data-models/blob/main/dca-template-config.json)

0 comments on commit 887afd8

Please sign in to comment.