stats/statistic-regression

Statistical regression library for PHP

dev-feature/simple-linear-regression 2024-10-27 23:00 UTC

Requires

• php: >=7.4

Requires (Dev)

• phpunit/phpunit: ^11.2

MIT

• Aime Zongo

README

Stats Regression est une bibliothèque PHP simple pour la régression linéaire, qui aide à modéliser la relation entre une variable dépendante (Y) et une variable indépendante (X) à l'aide d'un modèle linéaire. Elle inclut des méthodes pour ajuster un modèle de régression, faire des prédictions, et extraire des statistiques clés comme la pente, l'intercept, les erreurs standards, et les valeurs t.

Sommaire

• Stats Regression
  • Sommaire
  • Fonctionnalités
  • Prérequis
  • Installation
  • Utilisation
  • Tests
  • Contribution
  • Auteur
  • Licence

Fonctionnalités

• Ajustement de modèle : ajuste une régression linéaire simple à partir de deux séries de données.
• Prédictions : génère des prédictions basées sur le modèle ajusté.
• Statistiques de régression :
  • Pente (Slope) et Ordonnée à l'origine (Intercept)
  • Erreurs standards pour la pente et l'ordonnée à l'origine
  • Valeurs t pour tester la significativité des coefficients

Prérequis

• PHP >= 7.4
• Composer pour la gestion des dépendances
• PHPUnit pour exécuter les tests unitaires

Installation

1. Installation via Composer (recommandé) :

   composer require stats/statistic-regression
   

2. Clonez ce dépôt :

   git clone https://github.com/Ibrahimzongo/stats-regression.git

3. Installez les dépendances :

   composer install

Utilisation

Voici un exemple simple d'utilisation de la classe SimpleLinearRegression :

require 'vendor/autoload.php';

use Statistics\Regression\SimpleLinearRegression;

$x = [1, 2, 3, 4, 5];
$y = [1.5, 2.5, 2.8, 3.6, 3.9];

$regression = new SimpleLinearRegression();
$regression->fit($x, $y);

echo "Pente (Slope) : " . $regression->getSlope() . PHP_EOL;
echo "Ordonnée à l'origine (Intercept) : " . $regression->getIntercept() . PHP_EOL;
echo "Erreur standard pour la pente : " . $regression->getStdErrorSlope() . PHP_EOL;
echo "Erreur standard pour l'ordonnée : " . $regression->getStdErrorIntercept() . PHP_EOL;

$predictedY = $regression->predict(6);
echo "Prédiction pour x=6 : " . $predictedY . PHP_EOL;

Tests

Pour exécuter les tests unitaires, utilisez l'une des commandes suivantes :

# Directement avec PHPUnit
vendor/bin/phpunit

# Ou avec Composer 
composer test

Contribution

Les contributions sont les bienvenues ! Pour contribuer :

1. Forkez le projet.
2. Créez une branche pour votre fonctionnalité (git checkout -b feature/nouvelle-fonctionnalite).
3. Commitez vos modifications (git commit -m 'Ajout d'une nouvelle fonctionnalité').
4. Pushez vers la branche (git push origin feature/nouvelle-fonctionnalite).
5. Créez une Pull Request.

N'hésitez pas à ouvrir une issue pour rapporter un bug ou proposer une amélioration.

Auteur

Créé par Ibrahim Zongo.

Licence

Ce projet est sous licence MIT - voir le fichier LICENSE pour plus de détails.