https://github.com/omicsdi/xml-validator
https://github.com/omicsdi/xml-validator
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/omicsdi/xml-validator
- Owner: OmicsDI
- Created: 2015-08-18T15:58:33.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2023-03-16T15:14:39.000Z (about 3 years ago)
- Last Synced: 2024-03-26T05:51:22.124Z (about 2 years ago)
- Language: Java
- Size: 209 KB
- Stars: 1
- Watchers: 11
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# xml-validator
----------------------------------------
[](https://travis-ci.org/BD2K-DDI/xml-validator)
The xml validator provide a way of validating the XML files. The current library and corresponding commandline tool provides different options
for checking the quality of the files and the metadata they provide. The library is based on the rules and specifications for the [OmicsDI](https://github.com/BD2K-DDI/specifications)
project. The schema validation will provide a first validation of the file using the [OmicsDI](https://github.com/BD2K-DDI/specifications/blob/master/docs/schema/OmicsDISchema.xsd)
schema; the validation can be done for a directory or per files. Some of the validation steps, each entry in the file must contain this properties:
- id
- name
- publication (dates)
- omics_type
- repository
- full_dataset_link
For a full list of properties and rules, please visit the current specification [OmicsDI](https://github.com/BD2K-DDI/specifications).
## How to use the tool
The main commandline tool validatorCLI can be download from the releases pages [release](https://github.com/BD2K-DDI/xml-validator/releases), after unzip the tool it can be called as:
```sh
> java -jar validatorCLI.jar --help
usage: validatorCLI
-check Choose validation level (default level is
Warn):
Warn: This category do a complete Schema and
semantic validation of the file
Error: This category do a validation at level
of XML Schema
-h,--help print help message
-inFile Input file or Directory fo ve processed. If the
value is a directory, the procedure will be
applied to all files
-merge Convert a given directory files to an out put
with other options
-reportFile Record error/warn messages into outfile. If not
set, print message on the screen.
```
If the user is interested to validate the file at the schema level (not semantic validation):
```sh
> java -jar validatorCLI.jar -inFile PRIDE-XML.xml -check Error
```
The latest command will produce a file with the extension PRIDE-XML.xml.output.csv with all the errors **if the file have errors**. If the user is interested to do semantic validation of the
file, the command should be refined to:
```sh
> java -jar validatorCLI.jar -inFile PRIDE-XML.xml -check Warn
```
## Support
For any issue or support questions, please contact omicsdi-support@ebi.ac.uk