Módulo principal renombrado a API

src/redsem/main.py → src/redsem/api.py

@@ -28,6 +28,11 @@ def filtrar_primeras_posiciones(df, ultima_posicion=3):
         Si el argumento "df" no es un marco de datos.
         Si el argumento "df" no es un marco de datos.
     ValueError
     ValueError
         Si el marco de datos no tiene una columna llamada "posicion".
         Si el marco de datos no tiene una columna llamada "posicion".
+
+    Examples
+    --------
+    >>> df_filtrado = filtrar_primeras_posiciones(df, ultima_posicion=3)
+    >>> df_filtrado = filtrar_primeras_posiciones(df, ultima_posicion=5)
     """
     """
     if not isinstance(df, pd.DataFrame):
     if not isinstance(df, pd.DataFrame):
         raise TypeError('El argumento "df" debe ser un marco de datos')
         raise TypeError('El argumento "df" debe ser un marco de datos')
@@ -52,6 +57,11 @@ def extraer_particion(red, particion):
     -------
     -------
     list
     list
         Una lista con los nodos de la partición indicada.
         Una lista con los nodos de la partición indicada.
+
+    Examples
+    --------
+    >>> estimulos = extraer_particion(red, 'estimulo')
+    >>> respuestas = extraer_particion(red, 'respuesta')
     """
     """
     if not isinstance(red, nx.Graph):
     if not isinstance(red, nx.Graph):
         raise TypeError('El argumento "red" debe ser una red semántica')
         raise TypeError('El argumento "red" debe ser una red semántica')
@@ -125,6 +135,11 @@ def proyectar_red_por_estimulos(red, *estimulos):
     networkx.Graph
     networkx.Graph
         Una nueva red con las palabras respuesta asociadas a los estímulos indicados.
         Una nueva red con las palabras respuesta asociadas a los estímulos indicados.
 
 
+    Examples
+    --------
+    >>> red_individual = proyectar_red_por_estimulos(red, 'covid_semilla')
+    >>> red_par = proyectar_red_por_estimulos(red, 'covid_semilla', 'obesidad_semilla')
+    >>> red_trio = proyectar_red_por_estimulos(red, 'covid_semilla', 'obesidad_semilla', 'dieta_semilla')
     """
     """
     respuestas_asociadas = obtener_respuestas_asociadas(red, *estimulos)
     respuestas_asociadas = obtener_respuestas_asociadas(red, *estimulos)
     red_filtrada = filtrar_red_por_estimulos(red, *estimulos)
     red_filtrada = filtrar_red_por_estimulos(red, *estimulos)