From 4e9dda3ca8060bee5bcdd0a7387f634c2ae6a469 Mon Sep 17 00:00:00 2001 From: B13nch3n <b13nch3n_01@theb-si.de> Date: Sat, 7 May 2022 21:13:23 +0200 Subject: [PATCH] Explain remaining options --- validation/README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/validation/README.md b/validation/README.md index 224ec96..d97ee30 100644 --- a/validation/README.md +++ b/validation/README.md @@ -67,7 +67,7 @@ $ validate-mmcif-file -a extra model.cif $ ``` -If the URL points to a subdirectory, that must be reflected by the associates directory declared to the validation tool. The following example illustrates that the `extra` directory needs a `pae` directory storing the associated file as expected by `_ma_entry_associated_files.file_url`: +If the URL points to a subdirectory, this must be reflected by the associates directory tree declared to the validation tool. The following example illustrates that the `extra` directory needs a `pae` directory storing the associated file as expected by `_ma_entry_associated_files.file_url`: ```bash $ grep _ma_entry_associated_files.file_url model.cif @@ -81,10 +81,13 @@ $ validate-mmcif-file -a extra model.cif $ ``` +### Misc. arguments +|**`--help`** (**`-h`**)|Print a help/ usage page for the validation tool.| +|**`--dict-sdb <SDB FILE>`** (**`-d`**)|Format dictionary in (binary) SDB format used for validating a ModelCIF file. The container comes with a SDB for ModelCIF and one for the original PDBx/mmCIF format.| +|**`--out-file <JSON FILE>`** (**`-o`**)|Instead of printing the output to `stdout`, store it in a JSON file.| +|**`--verbose`** (**`-v`**)|Write information from intermediate steps to `stdout`. This includes the raw output of `CifCheck`.| -- basic usage -- remaining options ## How to run the container @@ -95,6 +98,6 @@ $ # Files in this directory <!-- LocalWords: PDBx ModelCIF TOC JSON CifCheck RCSB mmcif cif pdbx dic dir -<!-- LocalWords: url pae +<!-- LocalWords: url pae sdb SDB stdout --> --> -- GitLab