... | ... | @@ -198,13 +198,12 @@ pepcli castor create-import-columns |
|
|
The above switch-less invocation may lack information required to create import columns for some short pseudonym columns. These will be reported, and the command can then be invoked with switches to create columns for data import from affected Castor studies:
|
|
|
|
|
|
- the `--sp-column` switch specifies the column containing short pseudonym values that correspond with the Castor study's record IDs.
|
|
|
- when survey data are to be imported from the Castor study, and there is a survey package containing more than 10 surveys, the `--xml-structure-file` switch must be passed to work around a Castor bug that prevents `pepcli` from being able to list import columns. The Castor administrator should [export](https://helpdesk.castoredc.com/article/170-export-and-import-the-form-structure) the survey package structures from the Castor Web interface, which yields an XML file. The path to this XML file must then be passed to the `--xml-structure-file` switch to allow import columns to be created.
|
|
|
- when data are to be imported from surveys that are answered multiple times by participants, the `--answer-set-count` must be used to indicate how many answer sets are toe be expected. For example, if participants will answer a survey a maximum of 10 times, specify `--answer-set-count 10` to have the command create sufficient column names for all survey answers to be imported.
|
|
|
- when data are to be imported from surveys that are answered multiple times by participants, the `--answer-set-count` must be used to indicate how many answer sets are to be expected. For example, if participants will answer a survey a maximum of 10 times, specify `--answer-set-count 10` to have the command create sufficient column names for all survey answers to be imported.
|
|
|
|
|
|
E.g. when a Castor study is bound to short pseudonym column `ShortPseudonym.Covid.Castor.CovidQuestionnaires`, and that study contains large survey packages that are answered up to 30 times:
|
|
|
E.g. when a Castor study is bound to short pseudonym column `ShortPseudonym.Covid.Castor.CovidQuestionnaires`, and that study contains survey packages that are answered up to 30 times:
|
|
|
|
|
|
```
|
|
|
pepcli castor create-import-columns --sp-column ShortPseudonym.Covid.Castor.CovidQuestionnaires --answer-set-count 30 --xml-structure-file C:\Users\Gonk\Desktop\CastorExport.xml
|
|
|
pepcli castor create-import-columns --sp-column ShortPseudonym.Covid.Castor.CovidQuestionnaires --answer-set-count 30
|
|
|
```
|
|
|
|
|
|
### `castor export`
|
... | ... | @@ -221,9 +220,8 @@ pepcli castor list-import-columns --sp-column ShortPseudonym.Visit1.Castor.HomeQ |
|
|
|
|
|
While the output lists the columns that will be needed by the import process, missing columns are not created by this command. Use the [`castor create-import-columns` command](#castor-create-import-columns) instead to have the columns created instead of just listed. Alternatively, Data Administrator can `castor list` the columns, then invoke [`ama column`](#ama-column)'s `create` and `addTo` commands manually to create the columns and group them into the `Castor` column group.
|
|
|
|
|
|
The `castor list-import-columns` command accepts two optional switches:
|
|
|
The `castor list-import-columns` command accepts an optional switch:
|
|
|
|
|
|
- the `--xml-structure-file` switch can be used to work around a Castor bug that prevents `pepcli` from being able to list import columns when PEP is configured to import Castor survey data, and there are survey packages containing more than 10 surveys. For such situations, the Castor administrator should [export](https://helpdesk.castoredc.com/article/170-export-and-import-the-form-structure) the survey package structures from the Castor Web interface, which yields an XML file. The path to this XML file must then be passed to the `--xml-structure-file` switch to allow import columns to be listed.
|
|
|
- the `--answer-set-count` is used for Castor studies containing surveys that are answered multiple times by participants. PEP imports such survey data into [numbered columns](https://gitlab.pep.cs.ru.nl/pep-public/user-docs/-/wikis/Castor-integration#column-naming), and the switch indicates the number of answer sets to expect. For example, if participants will answer a survey a maximum of 10 times, specify `--answer-set-count 10` to have the command list sufficient column names for all survey answers to be imported.
|
|
|
|
|
|
### `castor list-sp-columns`
|
... | ... | |