浏览代码

Update README.md

Andrej Studen 4 年之前
父节点
当前提交
9a37272bc4
共有 1 个文件被更改,包括 27 次插入15 次删除
  1. 27 15
      README.md

+ 27 - 15
README.md

@@ -23,7 +23,7 @@ The initial set of setup lists is part of the distribution. Copy
 and import list archive to Labkey in the study. You will get list of lists by
 clicking on setup wheel at the top of the screen and selecting Manage lists.
 
-Create demographicData dataset. It can have no fields.
+Create demographicData dataset as part of the study. It can have no fields.
 
 Add a tab (Wheel->Page Admin Mode, click on a + tab). Add CRF Portal web part. It should appear empty. This will show all forms that we will create.
 
@@ -36,7 +36,11 @@ Three additional fields are required:
 - submissionDate (DateTime)
 - crfRef (String)
 
-[Here][exampleList] is an example. Open the inputLists list and add the name of the new list as a new entry. 
+[Here][exampleList] is an example included with the list archive. 
+
+Open the inputLists list and add the name of the new list as a new entry. The sample
+dataset is already there.
+
 Open the Forms list. Add new entry. Some fields can only have the default value:
 
 - formUrl: visit0
@@ -46,27 +50,35 @@ Open the Forms list. Add new entry. Some fields can only have the default value:
 Form name can be any string, including spaces. Setup query is still to be created, but it
 should name in Setup to distinguish it from others, say demographicsSetup. The last field, 
 master query is to be set to the created dataset list. Master queries must contain
-a participantCode field, and that is the field that will be used as the assignment field.
+a participantCode field, and that is the field that will be used as the assignment field. The
+sample Forms already has an entry for demographicsData.
 
-Finally, create the setup list. It should contain the fields in the image
+Finally, create the setup list. It should contain the fields as the sample demographicsSetup,
+shown in the image
 
 ![setup list][setupList]
 
-The list can have multiple entries, which are combined to constitute a logical form.
-The only programatical feature is that all entries should be completed before the 
-form is submitted for review. 
-An example entry is shown in the next figure
+The setup list can have multiple entries, which are combined to constitute a logical form.
+The only programatical feature is that all datasets that are combined in the form
+should be completed before the form is submitted for review. 
 
-![setup list example][setupListExample]
+For a new setup list entry, set Query Name to the dataset list and Title can be any string. 
+Other fields are set to NONE by default.
+
+![setup list example with NONE][setupListExample1]
 
-For a new entry, set Query Name to the dataset list. Title can be any string. For a more complex layout, 
-the dataset might have a flag which indicates a sub-list, say list of medications. The name
+A more complex dataset layout might contain a sub-list, say list of medication, which
+is enabled by a flag which is part of the dataset. The name
 of the flag, which is a variable in the dataset, must be given as showFlag, the value
 where list is to be filled is the showFlagValue, and showQuery is the sublist query which will
-be shown. In our case, this three fields are to be set to a NONE String, which indicates that no sublist
-is required. 
-~
-![setup list example with NONE][setupListExample1]
+be shown, as the following example shows:
+
+![setup list example][setupListExample]
+
+## Filling the form
+
+Add a tab (Wheel->Page Admin Mode, click on a + tab). Add CRF Portal web part. This will show all forms that we will create. If the setup
+worked, the Demographics form should appears in the CRF tab. 
 
 [studyParameters]: img/studyParametersSnapshot.png
 [exampleList]: img/exampleListSnapshot.png