Browse Source

Update README.md

Andrej Studen 4 years ago
parent
commit
a184ac0358
1 changed files with 20 additions and 15 deletions
  1. 20 15
      README.md

+ 20 - 15
README.md

@@ -25,10 +25,10 @@ clicking on setup wheel at the top of the screen and selecting Manage lists.
 
 
 Create demographicData dataset as part of the study. 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.
-
 ## Setting up a form
 ## Setting up a form
 
 
+### Datasets
+
 Create a dataset as a list. Go to Wheel->Manage Lists and Create List. Setup fields as you would normally do. 
 Create a dataset as a list. Go to Wheel->Manage Lists and Create List. Setup fields as you would normally do. 
 Three additional fields are required:
 Three additional fields are required:
 
 
@@ -41,28 +41,33 @@ Three additional fields are required:
 Open the inputLists list and add the name of the new list as a new entry. The sample
 Open the inputLists list and add the name of the new list as a new entry. The sample
 dataset is already there.
 dataset is already there.
 
 
-Open the Forms list. Add new entry. Some fields can only have the default value:
+### Forms
+CRF consists of a series of forms, contained in the Forms list.
+Each form is a logical assembly of datasets. Each form has a setup, which is a 
+list which specifies which datasets are part of the form, and a title. 
+The only programatical feature that a form has is that all its datasets 
+should be completed before the form is submitted for review. 
+Each form can be reviewed independently.
+
+Some fields are set to default values for historical reasons:
 
 
 - formUrl: visit0
 - formUrl: visit0
 - reviewFormUrl: reviewVisit0
 - reviewFormUrl: reviewVisit0
 - viewURL: visit0.view
 - viewURL: visit0.view
 
 
-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. The
-sample Forms already has an entry for demographicsData.
+The last field, master query is to be set to the created dataset list. Each form 
+has a master query that contains
+a participantCode field, and that is the field that will be used as the participant 
+assignment field for all datasets in the form. The
+sample Forms list already has an entry for demographicsData dataset.
 
 
-Finally, create the setup list. It should contain the fields as the sample demographicsSetup,
-shown in the image
+### Form setup
 
 
-![setup list][setupList]
+A form setup is a list of datasets in the form and contains the following fields:
 
 
-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][setupList]
 
 
-For a new setup list entry, set Query Name to the dataset list and Title can be any string. 
+For a new setup list entry, set Query Name to the dataset name with Title that can be any string. 
 Other fields are set to NONE by default.
 Other fields are set to NONE by default.
 
 
 ![setup list example with NONE][setupListExample1]
 ![setup list example with NONE][setupListExample1]