broom

balai

Aperçu

broom résume les informations clés sur les modèles dans Tidy tibble() s. broom fournit trois verbes pour le rendre pratique pour interagir avec les objets modèles:

• tidy() résume des informations sur les composants du modèle
• glance() rapporte des informations sur l'ensemble du modèle
• augment() ajoute des informations sur les observations à un ensemble de données

Pour une introduction détaillée, veuillez consulter vignette("broom") .

broom Trids 100+ modèles à partir de packages de modélisation populaires et presque tous les objets de modèle dans le package stats fourni avec Base R. vignette("available-methods") Répertorie la disponibilité de la méthode.

Si vous n'êtes pas familier avec les structures de données bien rangées et que vous souhaitez savoir comment elles peuvent vous faciliter la vie, nous vous recommandons fortement de lire les données bien rangées de Hadley Wickham.

Installation

 # we recommend installing the entire tidyverse 
# modeling set, which includes broom:
install.packages( " tidymodels " )

# alternatively, to install just broom:
install.packages( " broom " )

# to get the development version from GitHub:
install.packages( " pak " )
pak :: pak( " tidymodels/broom " )

Si vous trouvez un bogue, veuillez déposer un exemple reproductible minimal dans les problèmes.

Usage

tidy() produit un tibble() où chaque ligne contient des informations sur un composant important du modèle. Pour les modèles de régression, cela correspond souvent aux coefficients de régression. Cela peut être utile si vous souhaitez inspecter un modèle ou créer des visualisations personnalisées.

library( broom )

fit <- lm( Volume ~ Girth + Height , trees )
tidy( fit )
# > # A tibble: 3 x 5
# >   term        estimate std.error statistic  p.value
# >   <chr>          <dbl>     <dbl>     <dbl>    <dbl>
# > 1 (Intercept)  -58.0       8.64      -6.71 2.75e- 7
# > 2 Girth          4.71      0.264     17.8  8.22e-17
# > 3 Height         0.339     0.130      2.61 1.45e- 2

glance() renvoie un tibble avec exactement une rangée de mesures de fitness et de statistiques connexes. Ceci est utile pour vérifier la fausse spécification du modèle et comparer de nombreux modèles.

glance( fit )
# > # A tibble: 1 x 12
# >   r.squared adj.r.squared sigma statistic  p.value    df logLik   AIC   BIC
# >       <dbl>         <dbl> <dbl>     <dbl>    <dbl> <dbl>  <dbl> <dbl> <dbl>
# > 1     0.948         0.944  3.88      255. 1.07e-18     2  -84.5  177.  183.
# > # … with 3 more variables: deviance <dbl>, df.residual <int>, nobs <int>

augment ajoute des colonnes à un ensemble de données, contenant des informations telles que des valeurs ajustées, des résidus ou des affectations de cluster. Toutes les colonnes ajoutées à un ensemble de données ont . Préfixe pour empêcher les colonnes existantes d'être écrasées.

augment( fit , data = trees )
# > # A tibble: 31 x 9
# >    Girth Height Volume .fitted .resid .std.resid   .hat .sigma   .cooksd
# >    <dbl>  <dbl>  <dbl>   <dbl>  <dbl>      <dbl>  <dbl>  <dbl>     <dbl>
# >  1   8.3     70   10.3    4.84  5.46      1.50   0.116    3.79 0.0978   
# >  2   8.6     65   10.3    4.55  5.75      1.60   0.147    3.77 0.148    
# >  3   8.8     63   10.2    4.82  5.38      1.53   0.177    3.78 0.167    
# >  4  10.5     72   16.4   15.9   0.526     0.140  0.0592   3.95 0.000409 
# >  5  10.7     81   18.8   19.9  -1.07     -0.294  0.121    3.95 0.00394  
# >  6  10.8     83   19.7   21.0  -1.32     -0.370  0.156    3.94 0.00840  
# >  7  11       66   15.6   16.2  -0.593    -0.162  0.115    3.95 0.00114  
# >  8  11       75   18.2   19.2  -1.05     -0.277  0.0515   3.95 0.00138  
# >  9  11.1     80   22.6   21.4   1.19      0.321  0.0920   3.95 0.00348  
# > 10  11.2     75   19.9   20.2  -0.288    -0.0759 0.0480   3.95 0.0000968
# > # … with 21 more rows

Contributif

Nous accueillons les contributions de tous types!

Pour des questions et des discussions sur les packages TidyModels, la modélisation et l'apprentissage automatique, veuillez publier sur la communauté Posit. Si vous pensez avoir rencontré un bogue, veuillez soumettre un problème. Quoi qu'il en soit, apprenez à créer et à partager un reprex (un exemple minimal et reproductible), pour communiquer clairement sur votre code. Consultez plus de détails sur les directives contributives pour les packages TidyModels et comment obtenir de l'aide.

Si vous n'avez jamais directement contribué à un package R, broom est un excellent point de départ. Trouvez un problème avec la balise adaptée aux débutants et commentez que vous aimeriez le résoudre et nous vous aiderons à démarrer.

Généralement, nous encourageons également les corrections de typo, les rapports de bogues, les corrections de bogues et les demandes de fonctionnalités. Les commentaires sur la clarté de la documentation sont particulièrement précieux!

Si vous souhaitez ajouter des méthodes Tider pour de nouveaux objets de modèle, veuillez lire cet article sur le site Web de TidyModels.

Nous avons un code de conduite de contributeur. En participant à broom vous acceptez de respecter ses conditions.