jeggers commited on
Commit
5c65f64
·
verified ·
1 Parent(s): 6348e6a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +23 -0
README.md CHANGED
@@ -11,6 +11,29 @@ The dataset comprises several cryptic crossword clues from published crosswords.
11
 
12
  Each row of the dataset represents one clue from a published cryptic crossword. The crossword grid itself is not saved. The dataset covers a large portion of scraped blogs and digital archives and is considered nearly exhaustive for the covered sources. Data points include the clue, answer, definition, puzzle_date, puzzle_name, source_url, and source. Note that some information may be missing from individual rows, introducing potential errors or noise in the data.
13
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
  ## License & Usage
15
 
16
  This dataset is distributed under the Open Database License. Any rights in individual contents of the database are licensed under the Database Contents License. This allows for sharing and adapting the database, but requires users to attribute any public use of the database or works produces from the database.
 
11
 
12
  Each row of the dataset represents one clue from a published cryptic crossword. The crossword grid itself is not saved. The dataset covers a large portion of scraped blogs and digital archives and is considered nearly exhaustive for the covered sources. Data points include the clue, answer, definition, puzzle_date, puzzle_name, source_url, and source. Note that some information may be missing from individual rows, introducing potential errors or noise in the data.
13
 
14
+
15
+ ## Fields included in the dataset
16
+
17
+ The Cryptic Crossword Clues dataset contains the following fields:
18
+
19
+ - `clue`: This field contains the cryptic crossword clue from a published crossword. For example, 'Labourers going around spotted tools (8)'.
20
+
21
+ - `answer`: This field consists of the answer to the stated cryptic crossword clue. For instance, for the clue 'Labourers going around spotted tools (8)', the answer would be 'HANDSAWS'.
22
+
23
+ - `definition`: This field provides the definitions of the answers. In the above case, 'tools' would be the value of this field.
24
+
25
+ - `clue_number`: This represents the number of the clue in the particular crossword it's sourced from, like '17a'.
26
+
27
+ - `puzzle_date`: This field records the date on which the puzzle was published. It follows the format 'yyyy-mm-dd', as in '2017-08-25'.
28
+
29
+ - `puzzle_name`: The name of the publication and/or puzzle from which the clue is taken is recorded in this field, such as 'Quick Cryptic 904'.
30
+
31
+ - `source_url`: This holds the URL of the blog post from which the clue was scraped, such as 'https://times-xwd-times.livejournal.com/1799231.html'.
32
+
33
+ - `source`: In this field, the blog from which the clue is sourced is stated. For instance, 'times_xwd_times'.
34
+
35
+ Please note that these are the only fields included in the published Cryptic Crossword Clues dataset due to copyright issues respecting the scraped blogs. However, the original dataset includes annotation, puzzle_url, is_reviewed, and datetime_reviewed fields. Users interested in accessing the full dataset for non-commercial use (such as academic research groups) are encouraged to reach out via email to the dataset creator.
36
+
37
  ## License & Usage
38
 
39
  This dataset is distributed under the Open Database License. Any rights in individual contents of the database are licensed under the Database Contents License. This allows for sharing and adapting the database, but requires users to attribute any public use of the database or works produces from the database.