[](https://opensource.org/licenses/Apache-2.0)
[](https://badge.fury.io/py/asreview-notes-export)
# ASReview Notes Export Extension
This is a simple extension for [ASReview](https://github.com/asreview)  that can be used to export notes from the ASReview GUI while exporting the labeled or partially labeled dataset as .csv file.
## Installation
ASReview notes-export can be installed from PyPI:
```bash
pip install asreview-notes-export
```
After installation, check if the `asreview-notes-export` package is listed as an
extension. Use the following command:
```bash
asreview --help
```
It should list the `notes_export` subcommand.
## Usage
To export all the records from the dataset with the current state of labels and notes, we can use the following command:
```
asreview notes_export YOUR_ASREVIEW_FILE.asreview
```
To export only the records with notes from the dataset, we can use the following command:
```
asreview notes_export --only-with-notes YOUR_ASREVIEW_FILE.asreview
```
To include the labeling order in the exported dataset, use following optional argument:
```
asreview notes_export --labeling-order YOUR_ASREVIEW_FILE.asreview
```
By default, the filename of the output .csv is the same as the name of .asreview file. To save the output to .csv file with a custom filename, we can use the following command. We can either specify the extension:
```
asreview notes_export --only-with-notes YOUR_ASREVIEW_FILE.asreview -o YOUR_OUTPUT_FILENAME.csv
```
or only the filename will suffice, without an extension, using the following command:
```
asreview notes_export --only-with-notes YOUR_ASREVIEW_FILE.asreview -o YOUR_OUTPUT_FILENAME
```
Note that currently only .csv output is supported.
## License
The extension is published under the [Apache 2.0 license](https://github.com/rohitgarud/asreview-notes-export/blob/main/LICENSE).
## Contact
This is an unofficial extension of ASReview and is developed and maintained by [Rohit Garud](https://github.com/rohitgarud).
Raw data
{
"_id": null,
"home_page": "https://github.com/rohitgarud/asreview-notes-export",
"name": "asreview-notes-export",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "asreview notes export",
"author": "Rohit Garud",
"author_email": "rohit.garuda1992@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/82/b9/c6d77a1dd807e3af0f11438155bd35d539a732dc4d66a146b244f727c704/asreview-notes-export-0.0.7.tar.gz",
"platform": null,
"description": "[](https://opensource.org/licenses/Apache-2.0) \r\n[](https://badge.fury.io/py/asreview-notes-export)\r\n\r\n# ASReview Notes Export Extension\r\nThis is a simple extension for [ASReview](https://github.com/asreview) ![logo](https://raw.githubusercontent.com/asreview/asreview-artwork/e2e6e5ea58a22077b116b9c3d2a15bc3fea585c7/SVGicons/IconELAS/ELASeyes24px24px.svg \"ASReview\") that can be used to export notes from the ASReview GUI while exporting the labeled or partially labeled dataset as .csv file.\r\n\r\n## Installation\r\nASReview notes-export can be installed from PyPI:\r\n```bash\r\npip install asreview-notes-export\r\n```\r\n\r\nAfter installation, check if the `asreview-notes-export` package is listed as an\r\nextension. Use the following command:\r\n\r\n```bash\r\nasreview --help\r\n```\r\n\r\nIt should list the `notes_export` subcommand.\r\n\r\n## Usage\r\nTo export all the records from the dataset with the current state of labels and notes, we can use the following command:\r\n```\r\nasreview notes_export YOUR_ASREVIEW_FILE.asreview\r\n```\r\n\r\nTo export only the records with notes from the dataset, we can use the following command:\r\n```\r\nasreview notes_export --only-with-notes YOUR_ASREVIEW_FILE.asreview\r\n```\r\n\r\nTo include the labeling order in the exported dataset, use following optional argument:\r\n```\r\nasreview notes_export --labeling-order YOUR_ASREVIEW_FILE.asreview\r\n``` \r\n\r\nBy default, the filename of the output .csv is the same as the name of .asreview file. To save the output to .csv file with a custom filename, we can use the following command. We can either specify the extension:\r\n```\r\nasreview notes_export --only-with-notes YOUR_ASREVIEW_FILE.asreview -o YOUR_OUTPUT_FILENAME.csv\r\n``` \r\n\r\nor only the filename will suffice, without an extension, using the following command:\r\n```\r\nasreview notes_export --only-with-notes YOUR_ASREVIEW_FILE.asreview -o YOUR_OUTPUT_FILENAME\r\n``` \r\n\r\nNote that currently only .csv output is supported. \r\n\r\n## License\r\nThe extension is published under the [Apache 2.0 license](https://github.com/rohitgarud/asreview-notes-export/blob/main/LICENSE).\r\n\r\n## Contact\r\nThis is an unofficial extension of ASReview and is developed and maintained by [Rohit Garud](https://github.com/rohitgarud). \r\n\r\n",
"bugtrack_url": null,
"license": "",
"summary": "ASReview notes export extension",
"version": "0.0.7",
"split_keywords": [
"asreview",
"notes",
"export"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "82b9c6d77a1dd807e3af0f11438155bd35d539a732dc4d66a146b244f727c704",
"md5": "4e50ae1b17891f30386de70c4da113dd",
"sha256": "5af0aed6064164a69237717ff674fd9a9bcdc9b715d56551bc700ff2c5e91f8a"
},
"downloads": -1,
"filename": "asreview-notes-export-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "4e50ae1b17891f30386de70c4da113dd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26953,
"upload_time": "2023-03-24T16:18:46",
"upload_time_iso_8601": "2023-03-24T16:18:46.699008Z",
"url": "https://files.pythonhosted.org/packages/82/b9/c6d77a1dd807e3af0f11438155bd35d539a732dc4d66a146b244f727c704/asreview-notes-export-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-24 16:18:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "rohitgarud",
"github_project": "asreview-notes-export",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "asreview-notes-export"
}
JSON
