readme overhaul#1731
Conversation
There was a problem hiding this comment.
The file is removed from here and moved under docs folder but pyproject.toml still points to this deleted file on line number 9
readme = "PYPI.md"
| | **XPT** | SAS Transport Format (version 5) | | ||
| | **JSON** | Dataset-JSON ≥ v1.1 (CDISC standard) | | ||
| | **NDJSON** | Newline Delimited JSON | | ||
| | **XLSX** | Microsoft Excel | |
There was a problem hiding this comment.
We are missing csv format mention here.
| | `-d, --data TEXT` | Path to directory containing dataset files. Only the last value is used if specified multiple times. | | ||
| | `-dp, --dataset-path TEXT` | Absolute path to a single dataset file. Can be specified multiple times. | | ||
| | `-dxp, --define-xml-path TEXT` | Path to Define-XML. Also via `DEFINE_XML` env var. | | ||
| | `-ft, --filetype TEXT` | File extension filter applied to the `-d` directory (e.g. `xpt`). Takes priority over `--dataset-path` when both are provided. | |
There was a problem hiding this comment.
I think the -ft flag does not override the --dataset-path. They are exclusive.
There was a problem hiding this comment.
-ft, --filetype TEXT File extension to filter datasets. Has higher priority than --dataset-path parameter. This is the current text of the readme. I was just copying it
| | `-dep, --dotenv-path` | Path to `.env` file for environment variables. | | ||
| | `-l, --log-level` | Log verbosity: `debug`, `info`, `warn`, `error`, `critical`, `disabled`. | | ||
| | `-vx, --validate-xml` | XML validation toggle (default: enabled). Pass a value other than `y` to disable. | | ||
| | `-vo, --verbose-output` | Print each rule as it completes. | |
There was a problem hiding this comment.
This option in the current readme too but I did not see it attached to validate function in core.py file. Perhaps it removed form system but was not removed from the Readme.
| | `-s, --standard TEXT` | Filter by standard (e.g. `sdtmig`, `tig`). | | ||
| | `-v, --version TEXT` | Filter by standard version (e.g. `3-4`). | | ||
| | `-ss, --substandard TEXT` | Filter by substandard for integrated standards (e.g. `SDTM`, `ADaM`). | | ||
| | `-r, --rules TEXT` | List specific rule(s) by CORE ID. Repeatable. | |
There was a problem hiding this comment.
The long form here is not --rules but --rule-id in core.py file
| | `SUCCESS` | Rule ran; no issues found. | | ||
| | `SKIPPED` | Rule did not run (column/domain not found, schema validation off, outside scope). | | ||
| | `ISSUE_REPORTED` | Rule ran; issues were found. | | ||
| | `EXECUTION_ERROR` | Rule failed unexpectedly. Check the Issue Details tab for details. | |
There was a problem hiding this comment.
These are without _ now. It should be EXECUTION ERROR and ISSUE REPORTED. Please update these for consistency throughout the docs.
|
|
||
| ## Creating an Executable | ||
|
|
||
| Pre-built executables are available on the [Releases page](https://github.com/cdisc-org/cdisc-rules-engine/releases). If you need to build your own, see [README_Build_Executable.md](../README_Build_Executable.md) in the repository root. |
There was a problem hiding this comment.
This references to old README_Build_executable.md. The name and path is updated now.
RamilCDISC
left a comment
RamilCDISC
left a comment
There was a problem hiding this comment.
The PR updates the readme for the repository to be more organized docs. The updated docs are consistent with the previous read me. The validation was done by reviewing and comparing with previous documentation. In addition all the flags, options links were cross validated against the real code and original pages. All formatting was validated by rendering. The pages and side menu was validated by manual validation.
3 participants
readme overhaul with the intention to host the user guide as a streamlined github pages similar to https://cdisc-org.github.io/cdisc-open-rules/#/