add colrev.genai to docs

CoLRev-Environment · Jul 26, 2024 · a8c5dc8 · a8c5dc8
1 parent 6eea3cd
commit a8c5dc8
Show file tree

Hide file tree

Showing 9 changed files with 136 additions and 4 deletions.
diff --git a/colrev/package_manager/packages.json b/colrev/package_manager/packages.json
@@ -268,5 +268,8 @@
     },
     "colrev.github": {
         "dev_status": "maturing"
+    },
+    "colrev.genai": {
+        "dev_status": "experimental"
     }
 }
diff --git a/colrev/packages/critical_review/README.md b/colrev/packages/critical_review/README.md
@@ -23,7 +23,7 @@ The following packages are automatically set up in a critical review:
 
 Bélanger, F., & Crossler, R. E. (2011). Privacy in the digital age: a review of information privacy research in information systems. MIS Quarterly, 35(4), 1017-1041. doi:[10.2307/41409971](https://doi.org/10.2307/41409971)
 
-Jones, M. R., & Karsten, H. (2008). Giddens's structuration theory and information systems research. MIS Q1uarterly, 32(1), 127-157. doi:[10.2307/25148831
+Jones, M. R., & Karsten, H. (2008). Giddens's structuration theory and information systems research. MIS Quarterly, 32(1), 127-157. doi:[10.2307/25148831
 ](https://doi.org/10.2307/25148831)
 
 ## Methods papers

diff --git a/colrev/packages/genai/README.md b/colrev/packages/genai/README.md
@@ -1,4 +1,4 @@
-# GenAI
+## Summary
 
 ## Installation
 

diff --git a/colrev/packages/genai/pyproject.toml b/colrev/packages/genai/pyproject.toml
@@ -2,8 +2,9 @@
 name = "colrev.genai"
 description = "CoLRev package for GenAI"
 version = "0.1.0"
+license = "MIT"
 authors = ["Julian Prester <[email protected]>", "Gerit Wagner <[email protected]>"]
-documentation = "README.md"
+repository = "https://github.com/CoLRev-Environment/colrev/tree/main/colrev/packages/genai"
 
 [[tool.poetry.packages]]
 include = "src"

diff --git a/docs/source/manual/package_endpoints.json b/docs/source/manual/package_endpoints.json
@@ -511,6 +511,11 @@
             "status": "|MATURING|",
             "short_description": "Conditional Prescreen (:doc:`instructions </manual/packages/colrev.conditional_prescreen>`)"
         },
+        {
+            "package_endpoint_identifier": "colrev.genai",
+            "status": "|EXPERIMENTAL|",
+            "short_description": "GenAI (:doc:`instructions </manual/packages/colrev.genai>`)"
+        },
         {
             "package_endpoint_identifier": "colrev.prescreen_table",
             "status": "|MATURING|",
@@ -586,6 +591,11 @@
             "status": "|MATURING|",
             "short_description": "Screen (CLI) (:doc:`instructions </manual/packages/colrev.colrev_cli_screen>`)"
         },
+        {
+            "package_endpoint_identifier": "colrev.genai",
+            "status": "|EXPERIMENTAL|",
+            "short_description": "GenAI (:doc:`instructions </manual/packages/colrev.genai>`)"
+        },
         {
             "package_endpoint_identifier": "colrev.screen_table",
             "status": "|MATURING|",

diff --git a/docs/source/manual/packages.rst b/docs/source/manual/packages.rst
@@ -132,6 +132,7 @@ Packages
 
    packages/colrev.colrev_cli_prescreen.rst
    packages/colrev.conditional_prescreen.rst
+   packages/colrev.genai.rst
    packages/colrev.prescreen_table.rst
    packages/colrev.scope_prescreen.rst
 
@@ -155,6 +156,7 @@ Packages
 
 
    packages/colrev.colrev_cli_screen.rst
+   packages/colrev.genai.rst
    packages/colrev.screen_table.rst
 
 

diff --git a/docs/source/manual/packages/colrev.critical_review.rst b/docs/source/manual/packages/colrev.critical_review.rst
@@ -86,7 +86,7 @@ Examples
 
 Bélanger, F., & Crossler, R. E. (2011). Privacy in the digital age: a review of information privacy research in information systems. MIS Quarterly, 35(4), 1017-1041. doi:\ `10.2307/41409971 <https://doi.org/10.2307/41409971>`_
 
-Jones, M. R., & Karsten, H. (2008). Giddens's structuration theory and information systems research. MIS Q1uarterly, 32(1), 127-157. doi:\ `10.2307/25148831 <https://doi.org/10.2307/25148831>`_
+Jones, M. R., & Karsten, H. (2008). Giddens's structuration theory and information systems research. MIS Quarterly, 32(1), 127-157. doi:\ `10.2307/25148831 <https://doi.org/10.2307/25148831>`_
 
 Methods papers
 --------------

diff --git a/docs/source/manual/packages/colrev.genai.rst b/docs/source/manual/packages/colrev.genai.rst
@@ -0,0 +1,104 @@
+.. |EXPERIMENTAL| image:: https://img.shields.io/badge/status-experimental-blue
+   :height: 14pt
+   :target: https://colrev.readthedocs.io/en/latest/dev_docs/dev_status.html
+.. |MATURING| image:: https://img.shields.io/badge/status-maturing-yellowgreen
+   :height: 14pt
+   :target: https://colrev.readthedocs.io/en/latest/dev_docs/dev_status.html
+.. |STABLE| image:: https://img.shields.io/badge/status-stable-brightgreen
+   :height: 14pt
+   :target: https://colrev.readthedocs.io/en/latest/dev_docs/dev_status.html
+.. |VERSION| image:: /_static/svg/iconmonstr-product-10.svg
+   :width: 15
+   :alt: Version
+.. |GIT_REPO| image:: /_static/svg/iconmonstr-code-fork-1.svg
+   :width: 15
+   :alt: Git repository
+.. |LICENSE| image:: /_static/svg/iconmonstr-copyright-2.svg
+   :width: 15
+   :alt: Licencse
+.. |MAINTAINER| image:: /_static/svg/iconmonstr-user-29.svg
+   :width: 20
+   :alt: Maintainer
+.. |DOCUMENTATION| image:: /_static/svg/iconmonstr-book-17.svg
+   :width: 15
+   :alt: Documentation
+colrev.genai
+============
+
+|VERSION| Version: 0.1.0
+
+|MAINTAINER| Maintainer: Julian Prester, Gerit Wagner
+
+|LICENSE| License: MIT
+
+|GIT_REPO| Repository: `CoLRev-Environment/colrev <https://github.com/CoLRev-Environment/colrev/tree/main/colrev/packages/genai>`_
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 30 80
+
+   * - Endpoint
+     - Status
+     - Add
+   * - prescreen
+     - |EXPERIMENTAL|
+     - .. code-block::
+
+
+         colrev prescreen --add colrev.genai
+
+   * - screen
+     - |EXPERIMENTAL|
+     - .. code-block::
+
+
+         colrev screen --add colrev.genai
+
+
+Summary
+-------
+
+Installation
+------------
+
+To install the dependencies of ``colrev.genai``\ , run
+
+.. code-block::
+
+   pip install colrev[colrev.genai]
+
+prescreen
+---------
+
+Note: This document is currently under development. It will contain the following elements.
+
+
+* description
+* example
+
+.. code-block::
+
+   colrev settings -m "prescreen.prescreen_package_endpoints=[{'endpoint': 'colrev.genai'}]"
+
+screen
+------
+
+Note: This document is currently under development. It will contain the following elements.
+
+
+* description
+* example
+
+.. code-block::
+
+   colrev settings -m "screen.screen_package_endpoints=[{'endpoint': 'colrev.genai'}]"
+
+Links
+-----
+
+References
+----------
+
+Syriani, E., David, I., and Kumar, G. 2023. “Assessing the Ability of ChatGPT to Screen Articles for Systematic Reviews,” arXiv. (https://doi.org/10.48550/ARXIV.2307.06464).
+
+Castillo-Segura, P., Alario-Hoyos, C., Kloos, C. D., and Fernández Panadero, C. 2023. “Leveraging the Potential of Generative AI to Accelerate Systematic Literature Reviews: An Example in the Area of Educational Technology,” in 2023 World Engineering Education Forum - Global Engineering Deans Council (WEEF-GEDC), pp. 1–8. (https://doi.org/10.1109/WEEF-GEDC59520.2023.10344098).
diff --git a/docs/source/manual/packages_overview.json b/docs/source/manual/packages_overview.json
@@ -577,6 +577,12 @@
         "short_description": "Conditional Prescreen (:doc:`instructions </manual/packages/colrev.conditional_prescreen>`)",
         "endpoint_type": "prescreen"
     },
+    {
+        "package_endpoint_identifier": "colrev.genai",
+        "status": "|EXPERIMENTAL|",
+        "short_description": "GenAI (:doc:`instructions </manual/packages/colrev.genai>`)",
+        "endpoint_type": "prescreen"
+    },
     {
         "package_endpoint_identifier": "colrev.prescreen_table",
         "status": "|MATURING|",
@@ -655,6 +661,12 @@
         "short_description": "Screen (CLI) (:doc:`instructions </manual/packages/colrev.colrev_cli_screen>`)",
         "endpoint_type": "screen"
     },
+    {
+        "package_endpoint_identifier": "colrev.genai",
+        "status": "|EXPERIMENTAL|",
+        "short_description": "GenAI (:doc:`instructions </manual/packages/colrev.genai>`)",
+        "endpoint_type": "screen"
+    },
     {
         "package_endpoint_identifier": "colrev.screen_table",
         "status": "|MATURING|",