From fad5c299fd417df895e5e22959263a7047279a42 Mon Sep 17 00:00:00 2001 From: Tom Donoghue Date: Sun, 29 Oct 2023 02:50:03 -0400 Subject: [PATCH] docsitre updates --- doc/api.rst | 16 ++++++++-------- examples/plot_db_terms.py | 2 +- tutorials/plot_00-Overview.py | 2 +- tutorials/plot_01-WordsCollection.py | 4 ++-- tutorials/plot_02-WordsAnalysis.py | 3 +-- tutorials/plot_03-CountsCollection.py | 4 ++-- tutorials/plot_04-CountsAnalysis.py | 3 +-- tutorials/plot_06-MetaData.py | 3 +-- 8 files changed, 17 insertions(+), 20 deletions(-) diff --git a/doc/api.rst b/doc/api.rst index 617f0704..5363507e 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -217,15 +217,15 @@ Words plot_years plot_wordcloud -Utilities ---------- +File Management +--------------- -Utilities and file management. +File management and input / output. -File IO -~~~~~~~ +I/O +~~~ -.. currentmodule:: lisc.utils.io +.. currentmodule:: lisc.io.io .. autosummary:: :toctree: generated/ @@ -246,7 +246,7 @@ File IO Database Management ~~~~~~~~~~~~~~~~~~~ -.. currentmodule:: lisc.utils.db +.. currentmodule:: lisc.io.db .. autosummary:: :toctree: generated/ @@ -260,7 +260,7 @@ Database Management File Utilities ~~~~~~~~~~~~~~ -.. currentmodule:: lisc.utils.utils +.. currentmodule:: lisc.io.utils .. autosummary:: :toctree: generated/ diff --git a/examples/plot_db_terms.py b/examples/plot_db_terms.py index 22b3f0a6..cac9f624 100644 --- a/examples/plot_db_terms.py +++ b/examples/plot_db_terms.py @@ -8,7 +8,7 @@ ################################################################################################### # Import a function to create a LISC database file structure -from lisc.utils.db import create_file_structure +from lisc.io.db import create_file_structure ################################################################################################### # SCDB Database Structure diff --git a/tutorials/plot_00-Overview.py b/tutorials/plot_00-Overview.py index 2ec63dbb..da7daa1b 100644 --- a/tutorials/plot_00-Overview.py +++ b/tutorials/plot_00-Overview.py @@ -259,7 +259,7 @@ ################################################################################################### # Import a helper function to create a LISC file structure -from lisc.utils.db import create_file_structure +from lisc.io import create_file_structure ################################################################################################### # diff --git a/tutorials/plot_01-WordsCollection.py b/tutorials/plot_01-WordsCollection.py index 88287b6d..ba0ab1b7 100644 --- a/tutorials/plot_01-WordsCollection.py +++ b/tutorials/plot_01-WordsCollection.py @@ -18,10 +18,10 @@ from lisc import Words # Import the SCDB object, which organizes a database structure for saved data -from lisc.utils.db import SCDB +from lisc.io import SCDB # Import a utility function for saving out collected data -from lisc.utils.io import save_object +from lisc.io import save_object ################################################################################################### # Words Object diff --git a/tutorials/plot_02-WordsAnalysis.py b/tutorials/plot_02-WordsAnalysis.py index fc891301..34ac6225 100644 --- a/tutorials/plot_02-WordsAnalysis.py +++ b/tutorials/plot_02-WordsAnalysis.py @@ -24,8 +24,7 @@ from lisc.data import Articles, ArticlesAll # Import database and IO utilities to reload our previously collected data -from lisc.utils.db import SCDB -from lisc.utils.io import load_object +from lisc.io import SCDB, load_object # Import plots that are available for words data from lisc.plts.words import plot_wordcloud diff --git a/tutorials/plot_03-CountsCollection.py b/tutorials/plot_03-CountsCollection.py index 4aa94b45..310e4ee6 100644 --- a/tutorials/plot_03-CountsCollection.py +++ b/tutorials/plot_03-CountsCollection.py @@ -21,10 +21,10 @@ from lisc import Counts # Import the SCDB object, which defines a database structure for saved data -from lisc.utils.db import SCDB +from lisc.io import SCDB # Import a utility function for saving out collected data -from lisc.utils.io import save_object +from lisc.io import save_object ################################################################################################### # Counts Object diff --git a/tutorials/plot_04-CountsAnalysis.py b/tutorials/plot_04-CountsAnalysis.py index 3844471f..0001adc5 100644 --- a/tutorials/plot_04-CountsAnalysis.py +++ b/tutorials/plot_04-CountsAnalysis.py @@ -18,8 +18,7 @@ ################################################################################################### # Import database and IO utilities to reload our previously collected data -from lisc.utils.db import SCDB -from lisc.utils.io import load_object +from lisc.io import SCDB, load_object # Import plots that are available for co-occurrence analysis from lisc.plts.counts import plot_matrix, plot_clustermap, plot_dendrogram diff --git a/tutorials/plot_06-MetaData.py b/tutorials/plot_06-MetaData.py index 258dfb38..2adf0440 100644 --- a/tutorials/plot_06-MetaData.py +++ b/tutorials/plot_06-MetaData.py @@ -5,8 +5,7 @@ Exploring metadata collected and saved during data collections. """ -from lisc.utils.db import SCDB -from lisc.utils.io import load_object +from lisc.io import SCDB, load_object ################################################################################################### # Metadata