Skip to content

Una herramienta de búsqueda y síntesis de artículos de investigación escrita en Python.

Notifications You must be signed in to change notification settings

JCMiguel/repository-reviewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

90 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HBS - Herramienta de Búsqueda y Síntesis

Shield: CC BY-NC-SA 4.0

El propósito de esta herramienta es asistir en los procesos de búsqueda y mapeo sistemático (SMS) de la literatura vigente.

Requisitos

Esta aplicación necesita tener instalado el intérprete Python 3.9 para funcionar correctamente. Se deben instalar además todas las dependencias indicadas en el archivo requirements.txt.

Estructura de clases

Repo - Class Diagram

Engine - Class Diagram

Historic - Class Diagram

Configuración

  1. Renombrar los archivos template_repo_config.yml y template_params_config.yml como repo_config.yml y params_config.yml, respectivamente.

  2. Habilitar y deshabilitar los repositorios deseados en repo_config.yml cambiando el atributo enabled. Establecer en true para habilitar y en false para desactivar.

  3. Agregar las API Key correspondientes. Es necesario para esto crear una cuenta de desarrollador en cada repositorio.

  4. Agregar una dirección de correo en params_config.yml. Esto es requerido para realizar búsquedas en Pubmed.

Ejemplos de uso

A continuación se muestran ejemplos de uso frecuente.

Búsqueda sistemática de artículos

Búsqueda por título

Si deseamos buscar por título, basta con indicar encerrado entre comillas la cadena que necesitemos y pasarlo al script mediante el atributo --title. A continuación se muestra un ejemplo donde se desea buscar artículos cuyo título contenga la palabra "xai".

python .\querier.py --title "xai"

Búsqueda combinada

Se pueden combinar los atributos de ejecución para realizar una búsqueda más específica. Supongamos que se desea buscar los artículos que respondan a estos criterios:

TITLE = "xai"
AND
ABSTRACT = "xai"
AND
SINCE DATE >= 2015

El comando que realizar esta búsqueda resulta:

python .\querier.py --title "xai" --abstract "xai" --from-year 2015

Búsqueda por cadena de búsqueda avanzada

Para efectuar esta búsqueda se debe pasar un diccionario como argumento al atributo --query. Supongamos que se desea realizar esta búsqueda:

KEYWORD = ("histology" OR "histopathology")
AND
TITLE = "xai"

La línea de comandos necesaria para realizarla debe ser:

python .\querier.py --query '{ \"keyword\": [ \"histopalogy\", \"histopathology\" ], \"title\": \"xai\"}'

Fichaje de artículos y revisión

Fichar artículo

python .\indexer.py save

Listar fichas

python .\indexer.py get

Mostrar ficha por índice de fichaje

El siguiente comando muestra la ficha cuyo índice sea 1.

python .\indexer.py get --index 1

Listar fichas por nombre de archivo del artículo

python .\indexer.py get --filename example.pdf

Se puede efectuar una búsqueda parcial. La siguiente línea de comando lista todas las fichas que contengan la cadena "ai" en el campo "Nombre de Archivo"

python .\indexer.py get --filename ai

Editar ficha por número de índice

El siguiente comando permite editar la ficha con índice 1.

python .\indexer.py edit 1

Borrar ficha por número de índice

El siguiente comando permite eliminar la ficha con índice 1.

python .\indexer.py delete 1

Licencia

Este trabajo se desarrolla bajo el marco de la licencia Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

CC BY-NC-SA 4.0

About

Una herramienta de búsqueda y síntesis de artículos de investigación escrita en Python.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages