https://github.com/astutic/brat-standoff-to-json
Converts brat standoff format to JSONL format
https://github.com/astutic/brat-standoff-to-json
annotation-tool brat data-annotation
Last synced: 5 months ago
JSON representation
Converts brat standoff format to JSONL format
- Host: GitHub
- URL: https://github.com/astutic/brat-standoff-to-json
- Owner: astutic
- License: mit
- Created: 2020-08-19T06:35:34.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-01-29T10:43:33.000Z (over 4 years ago)
- Last Synced: 2024-12-24T15:23:43.054Z (over 1 year ago)
- Topics: annotation-tool, brat, data-annotation
- Language: Go
- Homepage:
- Size: 303 KB
- Stars: 12
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Welcome to Brat-standoff to JSON converter
Brat-standoff to JSON converter is a cli tool that converts the given brat standoff to JSON format
## Using brat Standoff Converter
```bash
git clone https://github.com/astutic/brat-standoff-to-json.git
```
OR
Download a release from [here](https://github.com/astutic/brat-standoff-to-json/releases)
and rename the file as brat-standoff-to-json
## Examples
### Converts and Prints JSONL (in acharya format) for brat files in the specified directory
```bash
go run main.go -p "./path/to/the/collection"
```
OR
```bash
brat-standoff-to-json -p "./path/to/the/collection"
```
##### example
```bash
go run main.go -p "./testData/news"
```
OR
```bash
brat-standoff-to-json -p "./testData/news"
```
### Save to an output file
```bash
go run main.go -p "./path/to/the/collection" --output "path/output-file-name"
```
OR
```bash
brat-standoff-to-json -p "./path/to/the/collection" --output "path/output-file-name"
```
##### example
> The command below will generate an output file named **acharyaFormat.jsonl** in the current directory
```bash
go run main.go -p "./testData/news" --output "./acharyaFormat.jsonl"
```
OR
```bash
brat-standoff-to-json -p "./testData/news" --output "./acharyaFormat.jsonl"
```
### Converting specific files
! **NOTE** the order of the .ann files an .txt files should be the same
`go run main.go --ann "file1.ann,file2.ann" --txt "file1.txt,file2.txt" --conf "file.conf"`
##### example
```bash
go run main.go --ann "path/to/first.ann,path/to/second.ann" --txt "path/to/first.txt,path/to/second.txt" --conf "path/to/annotation.conf"
```
OR
```bash
brat-standoff-to-json --ann "path/to/first.ann,path/to/second.ann" --txt "path/to/first.txt,path/to/second.txt" --conf "path/to/annotation.conf"
```
## Commands
| Command | Short hand | Type | Description | Default value |
| ---------- | ---------- | ------ | ------------------------------------------------------------------------- | ------------- |
| folderPath | p | string | Path to the folder containing the brat standoff collection |
| ann | a | string | Comma sepeartad locations of the annotation files (.ann) in correct order |
| txt | t | string | Comma sepeartad locations of the text files (.txt) in correct order |
| conf | c | string | Location of the annotation configuration file (annotation.conf) |
| output | o | string | Name of the output file to be generated |
| force | f | bool | If you wish to overwrite the generated file then set force to true | false |
| version | v | bool | Prints the version number | false |
## Original data displayed in brat
## Data from Brat converted to and uploaded to [Acharya](https://acharya.astutic.com)
## Note
**[ Windows PowerShell ]**
If you want to use the Brat → JSONL converter and If Brat Standoff **contains non English characters** Then its advised to set the following in PowerShell first
```powershell
$OutputEncoding = [console]::InputEncoding = [console]::OutputEncoding = New-Object System.Text.UTF8Encoding
```
#### Features that are currently unsupported:
- [Discontinuous text-bound annotations](https://brat.nlplab.org/standoff.html "https://brat.nlplab.org/standoff.html")
- [Advanced entity configuration](https://brat.nlplab.org/configuration.html#tool-configuration "https://brat.nlplab.org/configuration.html#tool-configuration")