Skip to content

Commit

Permalink
update file pathway for CROW input files
Browse files Browse the repository at this point in the history
  • Loading branch information
c-tomlin committed Nov 20, 2023
1 parent f841006 commit e3e6597
Showing 1 changed file with 23 additions and 27 deletions.
50 changes: 23 additions & 27 deletions CROW/Config_clusters.ini
Original file line number Diff line number Diff line change
@@ -1,49 +1,49 @@
; USEFUL INFORMATION:

; Welcome to the config file that makes the CROW, the Clerical Resolution
; Welcome to the config file that makes the CROW, the Clerical Resolution
; Online Widget, work with the data you are clerically reviewing!

; This is a file that you will have to edit and put next to the CROW_clusters.py
; in the filespace that contains the clerical matching files.
; Once you have edited it, you and your clerical matchers can simpy run the
; CROW_clusters.py from whatever Python IDE you are using. This way no one will
; have to edit any code.
; in the filespace that contains the clerical matching files.
; Once you have edited it, you and your clerical matchers can simpy run the
; CROW_clusters.py from whatever Python IDE you are using. This way no one will
; have to edit any code.

; As you can see this file is laid out into sections. Below is the section titles
; along with a description of what each section does. NOTE - do NOT change the
; section title names (i.e. the bits in square brackets ([])), only change the
; information underneath each section title.
; along with a description of what each section does. NOTE - do NOT change the
; section title names (i.e. the bits in square brackets ([])), only change the
; information underneath each section title.

; [custom_settings] - decide whether to include a commentbox in the CROW to allow
; your matchers to make any comments on what they are viewing.
; Also specify what comment values are displayed to clerical matchers.
; [matching_files_details] - tell the CROW where your matching files exist. This will
; [matching_files_details] - tell the CROW where your matching files exist. This will
; be your file path.
; [column_headers_and_order] - in this section you need to tell the CROW what your
; column headers are called and in what order you want them
; [column_headers_and_order] - in this section you need to tell the CROW what your
; column headers are called and in what order you want them
; to appear. For instance, common column headers are
; First Name or Postcode. See [column_headers_and_order]
; for more detail.
; Essentially these are the variables that may be shared
; across the one or more datasets you have linked.
; across the one or more datasets you have linked.
; You can specify the order you want them to appear in by
; typing in ', <your order number>' after the title. See
; [column_headers_and_order] for more detail.
; [columnfile_info_and_order] - in this section you need to tell the CROW what column
; variables you have in your clerical matching '.csv' files,
; [columnfile_info_and_order] - in this section you need to tell the CROW what column
; variables you have in your clerical matching '.csv' files,
; what dataset each column variable belongs to and what order
; they should be displayed in (these will displayed from left
; to right).
; NOTE: these columns must be in the same order as in
; [column_headers_and_order].
; TIP 1 - When telling the CROW what columns variables you have,
; it helps if you have one of your clerical matching files
; open when your are entering in what column variables you have.
; Any spelling errors or other inconsistencies will cause CROW to
; open when your are entering in what column variables you have.
; Any spelling errors or other inconsistencies will cause CROW to
; crash.
; TIP 2 - When entering what dataset each colun variable belongs
; to, PLEASE ENSURE they are consistent with what you have entered
; in the section [dataset_names].
; to, PLEASE ENSURE they are consistent with what you have entered
; in the section [dataset_names].

; SECTIONS TO EDIT:

Expand All @@ -54,21 +54,18 @@

commentbox = 1
comment_values = twins,nonsense record,needs expert review,should not be sent for review

num_records_checkpoint = 5

[matching_files_details]
; Enter the exact pathway where your clerical matching files exist
; Enter the exact pathway where your clerical matching files exist

#file_pathway = C:/Users/tomlic/Rwandan_linkage/Data/Clerical files
file_pathway = C:/Users/tomlic/PES_MATCH/Data/Clerical/
file_pathway = D:/repos/pes_match/Data/Clerical/

[column_headers_and_order]
; tell the CROW what your column headers are and in what order
; you want to order them in. This should be entered after the '=' sign
; you want to order them in. This should be entered after the '=' sign
; in the following order: Example = <Column_Title> , <Column_Order>


NAME = fullname, 1
DOB = full_dob, 2
REL = relationship, 3
Expand All @@ -82,14 +79,13 @@ FORENAME_LIST = forename_list, 10


[columnfile_info_and_order]
; tell the CROW what column variables you want to display
; tell the CROW what column variables you want to display
; and be clerically reviewed. Tell The CROW what dataset this
; belongs to and in what order.
; belongs to and in what order.
; This should be entered after the '=' sign in the following order:
; Example = <Column_Variable_From_CSV>
; NOTE: these columns must be in the same order as in [column_headers_and_order].


NAME = fullname, 1
DOB = full_dob, 2
REL = relationship, 3
Expand Down

0 comments on commit e3e6597

Please sign in to comment.