Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: pieterlukasse <[email protected]>
  • Loading branch information
forus and pieterlukasse committed Jun 28, 2024
1 parent 6dffe9f commit 02e8f07
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/Incremental-Data-Loading.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ When you update an entry, you must provide the complete data for this data type
For example, if you want to add or update the `Gender` attribute of a patient by incrementally uploading the `PATIENT_ATTRIBUTES` data type, you have to supply **all** other attributes of this patient again.
Note that in this case, you don't have to supply all sample information or molecular data types for this patient again as those are separate data types, and the rule applies to them in their own turn.

**Note:** Although incremental upload will create a genetic profile (name, description, etc.) when you upload molecular data for the first time, it does not update the profile attributes on subsequent uploads.
**Note:** Although incremental upload will create a genetic profile (name, description, etc.) when you upload molecular data for the first time, it does not update the profile (metadata)attributes on subsequent uploads.
It simply reuses the genetic profile if none of the identifying attributes (`cancer_study_identifier`, `genetic_alteration_type`, `datatype` and `stable_id`) have changed.

## Usage
Expand All @@ -20,7 +20,7 @@ The data files should contain complete information about entries you want to add

## Supported Data Types
Please note that incremental upload is supported for subset of data types only.
Not supported data types have to be omitted from the directory.
Unsupported data types have to be omitted from the directory.

Here is the list of data types as they specified in `datatype` attribute of meta file.

Expand Down
2 changes: 1 addition & 1 deletion docs/Using-the-metaImport-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ By adding `-o`, warnings will be overridden and import will start after validati
#### Incremental Upload

You have to specify `--data_directory` (or `-d`) instead of `--study_directory` (or `-s`) option to load data incrementally.
Incremental upload means incorporate data entries of certain data types without re-uploading the whole study.
Incremental upload enables data entries of certain data types to be updated without the need of re-uploading the whole study.
The data directory follows the same structure and data format as the study directory.
It should contain complete information about entries you want to add or update.
Please note that some data types like study are not supported and must not be present in the data directory.
Expand Down

0 comments on commit 02e8f07

Please sign in to comment.