Skip to content

Commit aaa455b

Browse files
author
Gerit Wagner
committed
update docs/first page
1 parent c4946e2 commit aaa455b

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

docs/source/index.rst

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ Search-Query Documentation
1717
:target: https://mybinder.org/v2/gh/CoLRev-Environment/search-query/HEAD?labpath=docs%2Fsource%2Fdemo.ipynb
1818

1919
Search-query is a Python package for **translating academic literature search queries (i.e., parsing and serializing)**, but also for **validating, simplifying, and improving** them.
20-
It implements various syntax validation checks ("linters" for search queries) and prints instructive messages to inform users about potential issues.
20+
It implements various syntax validation checks (aka. linters) and prints instructive messages to inform users about potential issues.
21+
These checks are valuable for preventing errors—an important step given that previous studies have found high error rates in search queries (Li & Rainer, 2023: **50%**; Salvador-Oliván et al., 2019: **90%**; Sampson & McGowan, 2006: **80%**).
2122

2223
We currently support PubMed, EBSCOHost, and Web of Science, but plan to extend search-query to support other databases.
23-
As a default it relies on the JSON schema proposed by an expert panel (Haddaway et al., 2022).
2424
The package can be used programmatically or through the command line, has zero dependencies, and can therefore be integrated in a variety of environments.
25-
The heuristics, parsers, and linters are battle-tested on over 500 peer-reviewed queries registered at `searchRxiv <https://www.cabidigitallibrary.org/journal/searchrxiv>`_.
25+
The parsers, and linters are battle-tested on over **500 (TO UPDATE)** peer-reviewed queries registered at `searchRxiv <https://www.cabidigitallibrary.org/journal/searchrxiv>`_.
2626

27-
A demo in a Jupyter Notebook (hosted on Binder) is available here:
27+
A Jupyter Notebook demo (hosted on Binder) is available here:
2828

2929
.. image:: https://mybinder.org/badge_logo.svg
3030
:target: https://mybinder.org/v2/gh/CoLRev-Environment/search-query/HEAD?labpath=docs%2Fsource%2Fdemo.ipynb
@@ -209,7 +209,21 @@ To develop a parser, see `dev-parser <dev_docs/parser.html>`_ docs.
209209
References
210210
----------------
211211

212-
Haddaway, N. R., Rethlefsen, M. L., Davies, M., Glanville, J., McGowan, B., Nyhan, K., & Young, S. (2022). A suggested data structure for transparent and repeatable reporting of bibliographic searching. *Campbell Systematic Reviews*, 18(4), e1288. doi:`10.1002/cl2.1288 <https://onlinelibrary.wiley.com/doi/full/10.1002/cl2.1288>`_
212+
.. parsed-literal::
213+
214+
Haddaway, N. R., Rethlefsen, M. L., Davies, M., Glanville, J., McGowan, B., Nyhan, K., & Young, S. (2022).
215+
A suggested data structure for transparent and repeatable reporting of bibliographic searching.
216+
*Campbell Systematic Reviews*, 18(4), e1288. doi: `10.1002/cl2.1288 <https://onlinelibrary.wiley.com/doi/full/10.1002/cl2.1288>`_
217+
218+
Li, Z., & Rainer, A. (2023). Reproducible Searches in Systematic Reviews: An Evaluation and Guidelines.
219+
IEEE Access, 11, 84048–84060. IEEE Access. https://doi.org/10.1109/ACCESS.2023.3299211
220+
221+
Salvador-Oliván, J. A., Marco-Cuenca, G., & Arquero-Avilés, R. (2019).
222+
Errors in search strategies used in systematic reviews and their effects on information retrieval. Journal of the Medical Library Association : JMLA, 107(2), 210. https://doi.org/10.5195/jmla.2019.567
223+
224+
Sampson, M., & McGowan, J. (2006). Errors in search strategies were identified by type and frequency.
225+
Journal of Clinical Epidemiology, 59(10), 1057–1063. https://doi.org/10.1016/j.jclinepi.2006.01.007
226+
213227
214228
.. toctree::
215229
:hidden:

0 commit comments

Comments
 (0)