From 702c3b37042da5d595a4d5611226b57413e21071 Mon Sep 17 00:00:00 2001 From: Nick Nicholas Date: Mon, 20 Feb 2017 13:36:28 +1100 Subject: [PATCH] Update README.md --- naprr/README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/naprr/README.md b/naprr/README.md index ad2924e..57227d9 100644 --- a/naprr/README.md +++ b/naprr/README.md @@ -6,7 +6,18 @@ To process the results file, just use a terminal to `cd `to the `naprr` folder a All reports will be written to the `/out` directory; this contains summary reports at the top level, and then a folder for each school with relevant reports inside. -All reports have been generated as requested, except for code frame_writing. For the code frame, we still need to understand the structure more clearly; but sensible real defaults have been put into the file from the results and reporting dataset, so the reports are structurally correct. +The current report structure in `/out` is: +* `codeframe.csv`: Flattened CSV file containing codeframe information for test items, along with the testlets and tests that contain them (given redundantly) +* `codeframe_writing.csv`: Flattened CSV file containing codeframe information for test items in writing, along with the testlets and tests that contain them (given redundantly). Given separately from `codeframe.csv`, because of the higher level of detail in writing test items. +* `domain_scores.csv`: Domain scores for each student in the file; students are indicated by their Platform Student Identifier. +* `participation.csv`: Which students participated in which NAPLAN tests. Demographic information and Platform Student Identifier are given for each student. +* `score_summary.csv`: Overall domain scores for each school and each test in the file. Schools identified by ACARA ID. +* _SCHOOL (ACARA ID)_ + * `domain_scores.csv`: Domain scores for each student in the school; students are indicated by their Platform Student Identifier. + * `participation.csv`: Which students in the school participated in which NAPLAN tests. Demographic information and Platform Student Identifier are given for each student. + * `score_summary.csv`: Overall domain scores for the school for each test in the file. Schools identified by ACARA ID. + +All reports have been generated as requested, except for `codeframe_writing.csv`. For the writing codeframe, we still need to understand the structure more clearly; but sensible real defaults have been put into the file from the results and reporting dataset, so the reports are structurally correct. To test the reporting engine only, as opposed to data parsing, delete the `/out` directory then run the `naprr` executable with the flag `-rewrite`. This will simply regenerate the reports without reloading the data.