Setting input directory in ./qa-catalogue script #473: documentation

pkiraly · May 17, 2024 · 5d7f0d0 · 5d7f0d0
1 parent 0bef0ac
commit 5d7f0d0
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -331,19 +331,20 @@ The following table summarizes the configuration variables. The script
 `qa-catalogue` can be used to set variables and execute analysis without a
 library specific configuration file:
 
-| variable          | `qa-catalogue`  | description  | default |
-| ----------------- | ----------------- | ------------ | ------- |
-| `ANALYSES`        | `-a`/`--analyses` | which tasks to run with `all-analyses` | `validate,sqlite,completeness,completeness_sqlite,classifications,authorities,tt_completeness,shelf_ready_completeness,serial_score,functional_analysis,pareto,marc_history` |
-|                   | `-c`/`--catalogue`| display name of the catalogue | `$NAME` |
-| `NAME`            | `-n`/`--name`     | name of the catalogue | qa-catalogue |
-| `BASE_INPUT_DIR`  | `-d`/`--input`    | parent directory of input file directories | `./input` |
-| `BASE_OUTPUT_DIR` | `-o`/--input`     | parent output directory | `./output` |
-| `MASK`            | `-m`/`--mask`     | a file mask which input files to process, e.g. `*.mrc` | `*` |
-| `TYPE_PARAMS`     | `-p`/`--params`   | parameters to pass to individual tasks (see below) | |
-| `SCHEMA`          | `-s`/`--schema`   | record schema | `MARC21` |
-| `UPDATE`          | `-u`/`--update`   | optional date of input files | |
-| `VERSION`         | `-v`/`--version`  | optional version number/date of the catalogue to compare changes | |
+| variable          | `qa-catalogue`      | description  | default |
+|-------------------|---------------------| ------------ | ------- |
+| `ANALYSES`        | `-a`/`--analyses`   | which tasks to run with `all-analyses` | `validate,sqlite,completeness,completeness_sqlite,classifications,authorities,tt_completeness,shelf_ready_completeness,serial_score,functional_analysis,pareto,marc_history` |
+|                   | `-c`/`--catalogue`  | display name of the catalogue | `$NAME` |
+| `NAME`            | `-n`/`--name`       | name of the catalogue | qa-catalogue |
+| `BASE_INPUT_DIR`  | `-d`/`--input`      | parent directory of input file directories | `./input` |
+| `BASE_OUTPUT_DIR` | `-o`/`--output`     | parent output directory | `./output` |
+| `MASK`            | `-m`/`--mask`       | a file mask which input files to process, e.g. `*.mrc` | `*` |
+| `TYPE_PARAMS`     | `-p`/`--params`     | parameters to pass to individual tasks (see below) | |
+| `SCHEMA`          | `-s`/`--schema`     | record schema | `MARC21` |
+| `UPDATE`          | `-u`/`--update`     | optional date of input files | |
+| `VERSION`         | `-v`/`--version`    | optional version number/date of the catalogue to compare changes | |
 | `WEB_CONFIG`      | `-w`/`--web-config` | update the specified configuration file of qa-catalogue-web | |
+|                   | `-d`/`--input-dir`  | subdirectory of input directory to read files from | |
 
 ## Detailed instructions
 

diff --git a/qa-catalogue b/qa-catalogue
@@ -12,7 +12,7 @@ Options:
   -c --catalogue  short name of the catalogue
   -n --name       name of the analysis (default: qa-catalogue)
   -i --input      input directory (default: ./input)
-  -d --input-dir  subdirectory of input directory to read files from (default: the NAME)
+  -d --input-dir  subdirectory of input directory to read files from
   -m --mask       input filename or glob (default: *)
   -o --output     output directory. Result are put into subdirectory NAME and _reports (default: ./output)
   -p --params     additional parameters passed to analyses