diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 2312782..d3bf61a 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -11,7 +11,7 @@ repos: - id: trailing-whitespace - id: end-of-file-fixer - id: check-yaml - - id: check-added-large-files + #- id: check-added-large-files - repo: https://github.com/johann-petrak/licenseheaders.git rev: v0.8.8 hooks: diff --git a/docs/README.html b/docs/README.html new file mode 100644 index 0000000..8893d6b --- /dev/null +++ b/docs/README.html @@ -0,0 +1,523 @@ + + + + + README.md - Grip + + + + + + +
+
+
+
+
+
+
+
+ + + +
+ +
+
+

+ README.md +

+
+
+ +
+
+

Руководство пользователя для программы "Statapp"

+

Условные обозначения

+

Взаимодействие - так отображается интерфестные части приложения с которыми пользователь может и должен взаимодействовать. к тами относятся кнопки, пункты меню, окна приложения, страницы в моделировании и тд.

+

Пример - так отображаются комментарии или описания. Обычно используются в качестве подписей к картинкам.

+

Параметр - так отображаются параметры, которые пользователь может получить в результате вычислений в приложении.

+

Введение

+

"Statapp" — это программное решение для статистического анализа и регрессионного моделирования, позволяющее специалистам в области данных проводить глубокий анализ и создавать точные прогностические модели.

+

Теоретические сведения

+

-- В разработке --

+

Начало работы

+

Генерация показателей

+
+

Генерация отклика

+

Перед тем как начать анализ, необходимо сгенерировать отклики, которые будут использоваться как зависимые переменные в моделях:

+
    +
  1. Перейдите в меню Генерация показателей.
    2. +
  2. Выберите Генерация отклика.
    3. +
+

После этого откроется окно Генерация отклика:

+

+

Пример пункта меню Генерация отклика

+
    +
  1. Укажите необходимые параметры для генерации данных и нажмите кнопку Сгенерировать.
    2. +
+

+

Пример окна Генерация отклика

+

После этого окно должно закрыться и на Белом листе в Главном окне появится колонка со случайно сгенерированными данными отклика по заданным показателям.

+
+

Генерация фактора

+

После генерации откликов следует сгенерировать факторы, которые будут служить независимыми переменными. Для генерации факторов необходимо выполнить следующие шаги:

+
    +
  1. Перейдите в меню Генерация показателей.
    2. +
  2. Выберите Генерация фактора.
    3. +
+

После этого откроется окно Генерация фактора:

+

+

Пример пункта меню Генерация фактора

+
    +
  1. Выберите нужный тип связи к отклику (прямая или обратная).
    2. +
  2. Укажите оставшиеся параметры для генерации данных и нажмите кнопку Сгенерировать.
    3. +
+

+

Пример окна Генерация отклика

+

Можно добавлять несколько факторов.

+
+

Анализ данных

+

После генерации отклика и факторов можно приступать к анализу данных.

+
+

Дисперсионный анализ

+
    +
  1. Перейдите в меню Анализ данных.
    2. +
  2. Выберите Дисперсионный анализ.
    3. +
+

+

Пример пункта меню Дисперсионный анализ

+

После этого откроется окно Дисперсионный анализ:

+

+

Пример окна Дисперсионный анализ

+
+

Корреляционный анализ

+
    +
  1. Перейдите в меню Анализ данных.
    2. +
  2. Выберите Корреляционный анализ.
    3. +
+

+

Пример пункта меню Корреляционный анализ

+

После этого откроется окно Корреляционный анализ:

+

+

Пример окна Корреляционный анализ

+
+

Моделирование

+

После генерации отклика и факторов можно перейти к построению регрессионных моделей.

+

Здесь вы можете увидеть параметры модели, её характеристики, прогноз и отклонения, а также график прогноза и отклонения.

+
    +
  1. Перейдите на вкладку Моделирование.
    2. +
  2. Выберите тип модели для построения: Линейный полином, Квадратичный полином или Преобразования.
    3. +
+

+

Пример список пунктов меню Моделирование

+

На странице Модель любого окна из Моделирование можно увидеть данные Коэффициент регрессии и Коэффициент значимости в виде таблицы для отклика и каждого из факторов. В нижней части окна располагаются вычисленные значения для параметров: Остаточная дисперсия, Остаточная дисперсия (масштабированная), F1 - отношение Фишера, Коэффициент множественной детерминации,

+

+

Пример страницы Модель окна Линейный полином

+

На странице Прогноз любого окна из Моделирование можно увидеть значения Прогноза и Отклонения для каждого ранее сгенерированного значения Отклика.

+

+

Пример страницы Прогноз окна Линейный полином

+

На странице График любого окна из Моделирование можно увидеть график Прогноза (график) и Отклонения (точки).

+

+

Пример страницы График окна Линейный полином

+

При необходимости, в окне Моделирование - Преобразования для каждого фактора вы можете выбрать одно из доступных преобразований.

+

+

Пример окна Преобразования

+

Для выбора преобразования для определенного фактора необходимо выполнить следующие шаги:

+
    +
  1. Перейдите на страницу Модель в окне Преобразования.
    2. +
  2. Дважды нажмите на нужную ячейку в колонке Преобразования.
    3. +
  3. Выберите необходимое преобразование из выпадающего списка.
    4. +
+

+

Пример списка выбора Преобразования фактора в окне Преобразования

+

Комментарий: если значения не персчитались попробуйте снять выделение с ячейки, путем нажатия на другую ячейку

+
+

Сохранение и открытие файла

+

Сгенерированные значения Отклика и Фактора из таблицы в Главном окне можно сохранить или зугрузить из файла .txt и .csv.

+

Сохранение файла

+
    +
  1. Перейдите в меню Файл.
    2. +
  2. Выберите Сохранить.
    3. +
+

+

Пример пункта меню Сохранить файл

+
    +
  1. Выберите путь сохранения и тип файла и нажмите кнопку Сохранить.
    2. +
+

Теперь файл будет сохранен по указаному вами пути, его можно переместить куда необходимо и при необходимости загрузить обратно в приложение.

+

Открытие файла

+
    +
  1. Перейдите в меню Файл.
    2. +
  2. Выберите Открыть.
    3. +
+

+

Пример пункта меню Открыть файл

+
    +
  1. Выберите путь до открываемого файла и нажмите кнопку Открыть.
    2. +
+

Приложение загрузит нужный вам файл, и при необходимости спросит нужно ли сохранять ваши текущие данные.

+ +
+
+
+ + + +
+
+
+
+
+
+
+
+ +