├── .github ├── CODEOWNERS.txt ├── ISSUE_TEMPLATE.md ├── workflows │ ├── test-coverage.yaml │ ├── pkgdown.yaml │ └── check-full.yaml ├── SUPPORT.md ├── CONTRIBUTING.md └── CODE_OF_CONDUCT.md ├── man ├── figures │ └── logo.png ├── reexports.Rd ├── glance.Rd ├── augment.Rd ├── tidy.Rd ├── grouped_glance.Rd ├── glance_performance.Rd ├── grouped_augment.Rd ├── grouped_tidy.Rd └── tidy_parameters.Rd ├── .lintr ├── tests ├── testthat.R └── testthat │ ├── test-hybrid_generics.R │ ├── test-generics.R │ ├── _snaps │ ├── hybrid_generics.md │ └── grouped_generics.md │ └── test-grouped_generics.R ├── hextools ├── broomExtra-hexagon_Indrajeet-Patil.png ├── broomExtra-hexagon_Indrajeet-Patil_5-08_4-39cm.ai ├── broomExtra-hexagon_Indrajeet-Patil_5-08_4-39cm.pdf └── broomExtra-hexagon_Indrajeet-Patil_5-08_4-39cm-cmyk_PRINT.pdf ├── .gitattributes ├── inst └── WORDLIST ├── codecov.yaml ├── R ├── reexports.R ├── generics.R ├── hybrid_easystats.R └── grouped_generics.R ├── broomExtra.Rproj ├── NAMESPACE ├── .Rbuildignore ├── .gitignore ├── pkgdown └── _pkgdown.yml ├── DESCRIPTION ├── NEWS.md ├── README.md ├── README.Rmd ├── LICENSE.md └── LICENSE /.github/CODEOWNERS.txt: -------------------------------------------------------------------------------- 1 | # CODEOWNERS for broomExtra 2 | .github/CODEOWNERS @IndrajeetPatil 3 | -------------------------------------------------------------------------------- /man/figures/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/IndrajeetPatil/broomExtra/HEAD/man/figures/logo.png -------------------------------------------------------------------------------- /.lintr: -------------------------------------------------------------------------------- 1 | linters: with_defaults(object_name_linter=NULL,line_length_linter(100),trailing_whitespace_linter=NULL) 2 | -------------------------------------------------------------------------------- /tests/testthat.R: -------------------------------------------------------------------------------- 1 | library(testthat) 2 | library(broomExtra) 3 | library(dplyr) 4 | 5 | test_check("broomExtra") 6 | -------------------------------------------------------------------------------- /hextools/broomExtra-hexagon_Indrajeet-Patil.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/IndrajeetPatil/broomExtra/HEAD/hextools/broomExtra-hexagon_Indrajeet-Patil.png -------------------------------------------------------------------------------- /hextools/broomExtra-hexagon_Indrajeet-Patil_5-08_4-39cm.ai: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/IndrajeetPatil/broomExtra/HEAD/hextools/broomExtra-hexagon_Indrajeet-Patil_5-08_4-39cm.ai -------------------------------------------------------------------------------- /hextools/broomExtra-hexagon_Indrajeet-Patil_5-08_4-39cm.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/IndrajeetPatil/broomExtra/HEAD/hextools/broomExtra-hexagon_Indrajeet-Patil_5-08_4-39cm.pdf -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | docs/* linguist-documentation 2 | man/* linguist-documentation 3 | misc/* linguist-documentation 4 | pkgdown/* linguist-documentation 5 | *.html linguist-documentation 6 | -------------------------------------------------------------------------------- /hextools/broomExtra-hexagon_Indrajeet-Patil_5-08_4-39cm-cmyk_PRINT.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/IndrajeetPatil/broomExtra/HEAD/hextools/broomExtra-hexagon_Indrajeet-Patil_5-08_4-39cm-cmyk_PRINT.pdf -------------------------------------------------------------------------------- /inst/WORDLIST: -------------------------------------------------------------------------------- 1 | CRAN's 2 | Lifecycle 3 | Nagelkerke's 4 | Otterstetter 5 | Tjur's 6 | easystats 7 | hexsticker 8 | instantiations 9 | lifecycle 10 | misspecified 11 | pkgdown 12 | tibble 13 | tibbles 14 | tidiers 15 | -------------------------------------------------------------------------------- /codecov.yaml: -------------------------------------------------------------------------------- 1 | coverage: 2 | status: 3 | project: 4 | default: 5 | target: auto 6 | threshold: 1% 7 | informational: true 8 | patch: 9 | default: 10 | target: auto 11 | threshold: 1% 12 | informational: true 13 | -------------------------------------------------------------------------------- /R/reexports.R: -------------------------------------------------------------------------------- 1 | # tidyverse ------------------------------------- 2 | 3 | #' @export 4 | #' @importFrom magrittr "%>%" 5 | magrittr::`%>%` 6 | 7 | #' @export 8 | #' @importFrom magrittr "%<>%" 9 | magrittr::`%<>%` 10 | 11 | #' @export 12 | #' @importFrom dplyr tibble 13 | dplyr::tibble 14 | 15 | #' @export 16 | #' @importFrom dplyr as_tibble 17 | dplyr::as_tibble 18 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | Please briefly describe your problem and what output you expect. If you have a question, please don't use this form. Instead, ask on or . 2 | 3 | Please include a minimal reproducible example (AKA a reprex). If you've never heard of a [reprex](https://reprex.tidyverse.org/) before, start by reading . 4 | 5 | --- 6 | 7 | Brief description of the problem 8 | 9 | ```r 10 | # insert reprex here 11 | ``` 12 | -------------------------------------------------------------------------------- /broomExtra.Rproj: -------------------------------------------------------------------------------- 1 | Version: 1.0 2 | 3 | RestoreWorkspace: No 4 | SaveWorkspace: No 5 | AlwaysSaveHistory: No 6 | 7 | EnableCodeIndexing: Yes 8 | UseSpacesForTab: Yes 9 | NumSpacesForTab: 2 10 | Encoding: UTF-8 11 | 12 | RnwWeave: Sweave 13 | LaTeX: pdfLaTeX 14 | 15 | StripTrailingWhitespace: Yes 16 | 17 | BuildType: Package 18 | PackageUseDevtools: Yes 19 | PackageInstallArgs: --no-multiarch --with-keep.source 20 | PackageRoxygenize: rd,collate,namespace 21 | 22 | QuitChildProcessesOnExit: Yes 23 | DisableExecuteRprofile: Yes 24 | -------------------------------------------------------------------------------- /NAMESPACE: -------------------------------------------------------------------------------- 1 | # Generated by roxygen2: do not edit by hand 2 | 3 | export("%<>%") 4 | export("%>%") 5 | export(as_tibble) 6 | export(augment) 7 | export(glance) 8 | export(glance_performance) 9 | export(grouped_augment) 10 | export(grouped_glance) 11 | export(grouped_tidy) 12 | export(tibble) 13 | export(tidy) 14 | export(tidy_parameters) 15 | import(dplyr) 16 | import(parameters) 17 | import(performance) 18 | import(rlang) 19 | importFrom(dplyr,as_tibble) 20 | importFrom(dplyr,tibble) 21 | importFrom(magrittr,"%<>%") 22 | importFrom(magrittr,"%>%") 23 | -------------------------------------------------------------------------------- /man/reexports.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/reexports.R 3 | \docType{import} 4 | \name{reexports} 5 | \alias{reexports} 6 | \alias{\%>\%} 7 | \alias{\%<>\%} 8 | \alias{tibble} 9 | \alias{as_tibble} 10 | \title{Objects exported from other packages} 11 | \keyword{internal} 12 | \description{ 13 | These objects are imported from other packages. Follow the links 14 | below to see their documentation. 15 | 16 | \describe{ 17 | \item{dplyr}{\code{\link[dplyr:reexports]{as_tibble}}, \code{\link[dplyr:reexports]{tibble}}} 18 | 19 | \item{magrittr}{\code{\link[magrittr:compound]{\%<>\%}}, \code{\link[magrittr:pipe]{\%>\%}}} 20 | }} 21 | 22 | -------------------------------------------------------------------------------- /.github/workflows/test-coverage.yaml: -------------------------------------------------------------------------------- 1 | # Workflow derived from https://github.com/r-lib/actions/tree/master/examples 2 | # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help 3 | on: 4 | push: 5 | branches: [main, master] 6 | pull_request: 7 | branches: [main, master] 8 | 9 | name: test-coverage 10 | 11 | jobs: 12 | test-coverage: 13 | runs-on: ubuntu-latest 14 | env: 15 | GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} 16 | 17 | steps: 18 | - uses: actions/checkout@v2 19 | 20 | - uses: r-lib/actions/setup-r@master 21 | with: 22 | use-public-rspm: true 23 | 24 | - uses: r-lib/actions/setup-r-dependencies@master 25 | with: 26 | extra-packages: covr 27 | 28 | - name: Test coverage 29 | run: covr::codecov() 30 | shell: Rscript {0} 31 | -------------------------------------------------------------------------------- /.Rbuildignore: -------------------------------------------------------------------------------- 1 | ^\cache$ 2 | ^codemeta\.json$ 3 | ^Meta$ 4 | ^doc$ 5 | ^.*\.Rproj$ 6 | ^\.Rproj\.user$ 7 | ^README\.Rmd$ 8 | ^Rplots.pdf$ 9 | ^README-.*\.png$ 10 | ^CONDUCT\.md$ 11 | ^SECURITY\.md$ 12 | ^cran-comments\.md$ 13 | ^CODE_OF_CONDUCT\.md$ 14 | ^SUPPORT\.md$ 15 | ^\.github$ 16 | ^NEWS$ 17 | ^docs$ 18 | ^revdep$ 19 | publication/* 20 | ^codecov\.yml$ 21 | ^\.coveralls\.yml$ 22 | ^\.travis\.yml$ 23 | ^_pkgdown\.yml$ 24 | ^appveyor\.yml$ 25 | ^.gitlab-ci\.yml$ 26 | ^data-raw$ 27 | ^pkgdown$ 28 | ^\.httr-oauth$ 29 | ^CRAN-RELEASE$ 30 | tests\^spelling 31 | ^LICENSE\.md$ 32 | ^\.lintr$ 33 | ^\.circleci$ 34 | ^tests/manual$ 35 | ^revdep$ 36 | ^\.covrignore$ 37 | ^\.github/ISSUE_TEMPLATE$ 38 | ^paper.*$ 39 | references.bib 40 | ^API$ 41 | ^\.pre-commit-config\.yaml$ 42 | ^\.github/workflows/R\.yaml$ 43 | ^\.github/workflows/pr-commands\.yaml$ 44 | hextools 45 | ^WIP/. 46 | ^CRAN-SUBMISSION$ 47 | -------------------------------------------------------------------------------- /man/glance.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/generics.R 3 | \name{glance} 4 | \alias{glance} 5 | \title{Retrieve model summary dataframe if it exists.} 6 | \usage{ 7 | glance(x, ...) 8 | } 9 | \arguments{ 10 | \item{x}{model or other R object to convert to single-row data frame} 11 | 12 | \item{...}{other arguments passed to methods} 13 | } 14 | \description{ 15 | Checks if a \code{glance} method exits for a given object, either in \code{{broom}} or in 16 | \code{{broom.mixed}}. If it does, return the model summary dataframe, if not, return 17 | a \code{NULL}. In this case, you can try the \code{\link[=glance_performance]{glance_performance()}} 18 | function. 19 | } 20 | \examples{ 21 | set.seed(123) 22 | lm.mod <- lm(Sepal.Length ~ Species, iris) 23 | broomExtra::glance(lm.mod) 24 | } 25 | \seealso{ 26 | \code{\link{grouped_glance}}, \code{\link{glance_performance}} 27 | } 28 | -------------------------------------------------------------------------------- /man/augment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/generics.R 3 | \name{augment} 4 | \alias{augment} 5 | \title{Retrieve augmented dataframe if it exists.} 6 | \usage{ 7 | augment(x, ...) 8 | } 9 | \arguments{ 10 | \item{x}{Model object or other R object with information to append to 11 | observations.} 12 | 13 | \item{...}{Addition arguments to \code{augment} method.} 14 | } 15 | \value{ 16 | A \code{\link[tibble:tibble]{tibble::tibble()}} with information about data points. 17 | } 18 | \description{ 19 | Checks if a \code{augment} method exits for a given object, either in \code{{broom}} or 20 | in \code{{broom.mixed}}. If it does, return the model summary dataframe, if not, 21 | return a \code{NULL}. 22 | } 23 | \examples{ 24 | set.seed(123) 25 | lm.mod <- lm(Sepal.Length ~ Species, iris) 26 | broomExtra::augment(lm.mod) 27 | } 28 | \seealso{ 29 | \code{\link{grouped_augment}} 30 | } 31 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | Meta 2 | doc 3 | # Windows image file caches 4 | Thumbs.db 5 | ehthumbs.db 6 | 7 | # Folder config file 8 | Desktop.ini 9 | # Recycle Bin used on file shares 10 | $RECYCLE.BIN/ 11 | # Windows Installer files 12 | *.cab 13 | *.msi 14 | *.msm 15 | *.msp 16 | # Windows shortcuts 17 | *.lnk 18 | # ========================= 19 | # Operating System Files 20 | # OSX 21 | .DS_Store 22 | .AppleDouble 23 | .LSOverride 24 | # Thumbnails 25 | ._* 26 | # Files that might appear in the root of a volume 27 | .DocumentRevisions-V100 28 | .fseventsd 29 | .Spotlight-V100 30 | .TemporaryItems 31 | .Trashes 32 | .VolumeIcon.icns 33 | # Directories potentially created on remote AFP share 34 | .AppleDB 35 | .AppleDesktop 36 | Network Trash Folder 37 | Temporary Items 38 | .apdisk 39 | # R Studio files 40 | .Rproj.user 41 | .Rhistory 42 | .RData 43 | .Ruserdata 44 | inst/doc 45 | .httr-oauth 46 | revdep/checks 47 | revdep/library 48 | revdep/checks.noindex 49 | revdep/library.noindex 50 | revdep/data.sqlite 51 | /doc/ 52 | /Meta/ 53 | CRAN-SUBMISSION 54 | -------------------------------------------------------------------------------- /man/tidy.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/generics.R 3 | \name{tidy} 4 | \alias{tidy} 5 | \title{Retrieve tidy dataframe if it exists} 6 | \usage{ 7 | tidy(x, ...) 8 | } 9 | \arguments{ 10 | \item{x}{An object to be converted into a tidy \code{\link[tibble:tibble]{tibble::tibble()}}.} 11 | 12 | \item{...}{Additional arguments to tidying method.} 13 | } 14 | \value{ 15 | A \code{\link[tibble:tibble]{tibble::tibble()}} with information about model components. 16 | } 17 | \description{ 18 | Checks if a \code{tidy} method exits for a given object, either in \code{{broom}} or in 19 | \code{{broom.mixed}}. If it does, it turn an object into a tidy tibble, if not, 20 | return a \code{NULL}. In this case, you can try the 21 | \code{\link[=tidy_parameters]{tidy_parameters()}} function. 22 | } 23 | \examples{ 24 | set.seed(123) 25 | lm.mod <- lm(Sepal.Length ~ Species, iris) 26 | broomExtra::tidy(x = lm.mod, conf.int = TRUE) 27 | } 28 | \seealso{ 29 | \code{\link{grouped_tidy}}, \code{\link{tidy_parameters}} 30 | } 31 | -------------------------------------------------------------------------------- /man/grouped_glance.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/grouped_generics.R 3 | \name{grouped_glance} 4 | \alias{grouped_glance} 5 | \title{Grouped model summary} 6 | \usage{ 7 | grouped_glance(data, grouping.vars, ..f, ...) 8 | } 9 | \arguments{ 10 | \item{data}{Dataframe (or tibble) from which variables are to be taken.} 11 | 12 | \item{grouping.vars}{Grouping variables.} 13 | 14 | \item{..f}{A function, or function name as a string.} 15 | 16 | \item{...}{<\link[rlang:dyn-dots]{dynamic}> Arguments for \code{.fn}.} 17 | } 18 | \description{ 19 | Model summary output from grouped analysis of any function that 20 | has \code{data} argument in its function call. 21 | } 22 | \examples{ 23 | set.seed(123) 24 | library(dplyr) 25 | 26 | # linear mixed effects model 27 | grouped_glance( 28 | data = mutate(MASS::Aids2, interval = death - diag), 29 | grouping.vars = sex, 30 | ..f = lme4::lmer, 31 | formula = interval ~ age + (1 | status), 32 | control = lme4::lmerControl(optimizer = "bobyqa") 33 | ) 34 | } 35 | \seealso{ 36 | \code{\link{glance}} 37 | } 38 | -------------------------------------------------------------------------------- /man/glance_performance.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/hybrid_easystats.R 3 | \name{glance_performance} 4 | \alias{glance_performance} 5 | \title{Model performance summary dataframes using \code{{broom}} and \code{{easystats}}} 6 | \usage{ 7 | glance_performance(x, ...) 8 | } 9 | \arguments{ 10 | \item{x}{model or other R object to convert to single-row data frame} 11 | 12 | \item{...}{other arguments passed to methods} 13 | } 14 | \value{ 15 | A data frame (with one row) and one column per "index". 16 | } 17 | \description{ 18 | Computes indices of model performance for regression models. 19 | } 20 | \details{ 21 | The function will attempt to get these details either using 22 | \code{\link[broom:reexports]{broom::glance()}} or \code{\link[performance:model_performance]{performance::model_performance()}}. If both function 23 | provide model performance measure summaries, the function will try to 24 | combine them into a single dataframe. Measures for which these two packages 25 | have different naming conventions, both will be retained. 26 | } 27 | \examples{ 28 | 29 | set.seed(123) 30 | mod <- lm(mpg ~ wt + cyl, data = mtcars) 31 | broomExtra::glance_performance(mod) 32 | } 33 | -------------------------------------------------------------------------------- /man/grouped_augment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/grouped_generics.R 3 | \name{grouped_augment} 4 | \alias{grouped_augment} 5 | \title{Grouped augment} 6 | \usage{ 7 | grouped_augment(data, grouping.vars, ..f, ..., augment.args = list()) 8 | } 9 | \arguments{ 10 | \item{data}{Dataframe (or tibble) from which variables are to be taken.} 11 | 12 | \item{grouping.vars}{Grouping variables.} 13 | 14 | \item{..f}{A function, or function name as a string.} 15 | 16 | \item{...}{<\link[rlang:dyn-dots]{dynamic}> Arguments for \code{.fn}.} 17 | 18 | \item{augment.args}{A list of arguments to be used in the relevant \code{S3} method.} 19 | } 20 | \value{ 21 | A \code{\link[tibble:tibble]{tibble::tibble()}} with information about data points. 22 | } 23 | \description{ 24 | Augmented data from grouped analysis of any function that has 25 | \code{data} argument in its function call. 26 | } 27 | \examples{ 28 | set.seed(123) 29 | library(dplyr) 30 | 31 | # linear mixed effects model 32 | grouped_augment( 33 | data = mutate(MASS::Aids2, interval = death - diag), 34 | grouping.vars = sex, 35 | ..f = lme4::lmer, 36 | formula = interval ~ age + (1 | status), 37 | control = lme4::lmerControl(optimizer = "bobyqa") 38 | ) 39 | } 40 | \seealso{ 41 | \code{\link{augment}} 42 | } 43 | -------------------------------------------------------------------------------- /man/grouped_tidy.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/grouped_generics.R 3 | \name{grouped_tidy} 4 | \alias{grouped_tidy} 5 | \title{Grouped tidy analysis} 6 | \usage{ 7 | grouped_tidy(data, grouping.vars, ..f, ..., tidy.args = list()) 8 | } 9 | \arguments{ 10 | \item{data}{Dataframe (or tibble) from which variables are to be taken.} 11 | 12 | \item{grouping.vars}{Grouping variables.} 13 | 14 | \item{..f}{A function, or function name as a string.} 15 | 16 | \item{...}{<\link[rlang:dyn-dots]{dynamic}> Arguments for \code{.fn}.} 17 | 18 | \item{tidy.args}{A list of arguments to be used in the relevant \code{S3} method.} 19 | } 20 | \value{ 21 | A \code{\link[tibble:tibble]{tibble::tibble()}} with information about model components. 22 | } 23 | \description{ 24 | Tidy output from grouped analysis of any function that has 25 | \code{data} argument in its function call 26 | } 27 | \examples{ 28 | set.seed(123) 29 | library(dplyr) 30 | 31 | # linear mixed effects model 32 | grouped_tidy( 33 | data = mutate(MASS::Aids2, interval = death - diag), 34 | grouping.vars = sex, 35 | ..f = lme4::lmer, 36 | formula = interval ~ age + (1 | status), 37 | control = lme4::lmerControl(optimizer = "bobyqa"), 38 | tidy.args = list(conf.int = TRUE, conf.level = 0.99) 39 | ) 40 | } 41 | \seealso{ 42 | \code{\link{tidy}} 43 | } 44 | -------------------------------------------------------------------------------- /pkgdown/_pkgdown.yml: -------------------------------------------------------------------------------- 1 | url: https://indrajeetpatil.github.io/broomExtra/ 2 | 3 | template: 4 | bootstrap: 5 5 | bootswatch: cyborg 6 | theme: arrow-dark 7 | includes: 8 | in-header: | 9 | 10 | bslib: 11 | base_font: {google: "Roboto"} 12 | heading_font: {google: "Roboto"} 13 | code_font: {google: "JetBrains Mono"} 14 | 15 | development: 16 | mode: auto 17 | 18 | authors: 19 | Indrajeet Patil: 20 | href: https://sites.google.com/site/indrajeetspatilmorality/ 21 | 22 | reference: 23 | - title: Hybrid functions from `{broom}` and `{easystats}` 24 | desc: These are the primary functions that combine functionalities from these two ecosystems. 25 | contents: 26 | - tidy_parameters 27 | - glance_performance 28 | 29 | - title: Generics for `{broom}` and `{broom.mixed}` 30 | desc: Generic functions used for tidy tibbles, model summaries, and augmented data frames. 31 | contents: 32 | - tidy 33 | - glance 34 | - augment 35 | 36 | - title: Grouped variants of generics 37 | desc: Using generic functions across all combinations of grouping variables in a dataframe. 38 | contents: 39 | - grouped_tidy 40 | - grouped_glance 41 | - grouped_augment 42 | 43 | - title: Reexported functions 44 | desc: Useful functions re-exported from other packages. 45 | contents: 46 | - "%>%" 47 | -------------------------------------------------------------------------------- /.github/workflows/pkgdown.yaml: -------------------------------------------------------------------------------- 1 | # Workflow derived from https://github.com/r-lib/actions/tree/v2/examples 2 | # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help 3 | on: 4 | push: 5 | branches: [main, master] 6 | pull_request: 7 | branches: [main, master] 8 | release: 9 | types: [published] 10 | workflow_dispatch: 11 | 12 | name: pkgdown 13 | 14 | jobs: 15 | pkgdown: 16 | runs-on: ubuntu-latest 17 | # Only restrict concurrency for non-PR jobs 18 | concurrency: 19 | group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }} 20 | env: 21 | GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} 22 | steps: 23 | - uses: actions/checkout@v2 24 | 25 | - uses: r-lib/actions/setup-pandoc@v2 26 | with: 27 | pandoc-version: '2.18' 28 | 29 | - uses: r-lib/actions/setup-r@v2 30 | with: 31 | use-public-rspm: true 32 | 33 | - uses: r-lib/actions/setup-r-dependencies@v2 34 | with: 35 | extra-packages: r-lib/pkgdown, local::. 36 | needs: website 37 | 38 | - name: Build site 39 | run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) 40 | shell: Rscript {0} 41 | 42 | - name: Deploy to GitHub pages 🚀 43 | if: github.event_name != 'pull_request' 44 | uses: JamesIves/github-pages-deploy-action@4.1.4 45 | with: 46 | clean: false 47 | branch: gh-pages 48 | folder: docs -------------------------------------------------------------------------------- /man/tidy_parameters.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/hybrid_easystats.R 3 | \name{tidy_parameters} 4 | \alias{tidy_parameters} 5 | \title{Tidy dataframes of model parameters using \code{{broom}} and \code{{easystats}}} 6 | \usage{ 7 | tidy_parameters(x, conf.int = TRUE, ...) 8 | } 9 | \arguments{ 10 | \item{x}{An object to be converted into a tidy \code{\link[tibble:tibble]{tibble::tibble()}}.} 11 | 12 | \item{conf.int}{Indicating whether or not to include a confidence interval in 13 | the tidied output (defaults to \code{TRUE}).} 14 | 15 | \item{...}{Additional arguments that will be passed to 16 | \code{\link[parameters:model_parameters]{parameters::model_parameters()}} or \code{\link[broom:reexports]{broom::tidy()}}, whichever method 17 | works. Note that you should pay attention to different naming conventions 18 | across these packages. For example, the required confidence interval width 19 | is specified using \code{ci} argument in \code{parameters::model_parameters}, while 20 | using \code{conf.level} in \code{broom::tidy}.} 21 | } 22 | \value{ 23 | A data frame of indices related to the model's parameters. 24 | } 25 | \description{ 26 | Computes parameters for regression models. 27 | } 28 | \details{ 29 | The function will attempt to get these details first using 30 | \code{\link[parameters:model_parameters]{parameters::model_parameters()}}, and if this fails, then using 31 | \code{\link[broom:reexports]{broom::tidy()}}. 32 | } 33 | \examples{ 34 | set.seed(123) 35 | mod <- lm(mpg ~ wt + cyl, data = mtcars) 36 | broomExtra::tidy_parameters(mod) 37 | } 38 | -------------------------------------------------------------------------------- /DESCRIPTION: -------------------------------------------------------------------------------- 1 | Type: Package 2 | Package: broomExtra 3 | Title: Enhancements for 'broom' and 'easystats' Package Families 4 | Version: 5.0.0 5 | Authors@R: 6 | person(given = "Indrajeet", 7 | family = "Patil", 8 | role = c("aut", "cre", "cph"), 9 | email = "patilindrajeet.science@gmail.com", 10 | comment = c(ORCID = "0000-0003-1995-6531", Twitter = "@patilindrajeets")) 11 | Maintainer: Indrajeet Patil 12 | Description: Provides helper functions that assist in data 13 | analysis workflows involving regression analyses. The goal is to 14 | combine the functionality offered by different set of packages 15 | ('broom', 'broom.mixed', 'parameters', and 'performance') through a 16 | common syntax to return tidy dataframes containing model parameters 17 | and performance measure summaries. The 'grouped_' variants of the 18 | generics provides a convenient way to execute functions across a 19 | combination of grouping variable(s) in a dataframe. 20 | License: GPL-3 | file LICENSE 21 | URL: https://indrajeetpatil.github.io/broomExtra/, 22 | https://github.com/IndrajeetPatil/broomExtra 23 | BugReports: https://github.com/IndrajeetPatil/broomExtra/issues 24 | Depends: 25 | R (>= 3.6.0) 26 | Imports: 27 | broom, 28 | broom.mixed (>= 0.2.9.3), 29 | dplyr, 30 | magrittr, 31 | parameters (>= 0.17.0), 32 | performance (>= 0.9.0), 33 | rlang 34 | Suggests: 35 | generics, 36 | lavaan, 37 | lme4, 38 | MASS, 39 | rmarkdown, 40 | testthat 41 | Encoding: UTF-8 42 | Language: en-US 43 | Roxygen: list(markdown = TRUE, roclets = c("rd", "namespace", "collate")) 44 | RoxygenNote: 7.2.1 45 | Config/testthat/edition: 3 46 | -------------------------------------------------------------------------------- /tests/testthat/test-hybrid_generics.R: -------------------------------------------------------------------------------- 1 | # hybrid methods work ------------------------------------------------------ 2 | 3 | test_that( 4 | desc = "hybrid methods works", 5 | code = { 6 | options(tibble.width = Inf) 7 | library(lme4) 8 | 9 | # merMord 10 | set.seed(123) 11 | lmm_mod <- lmer(Reaction ~ Days + (Days | Subject), sleepstudy) 12 | lmm_tidy <- tidy_parameters(lmm_mod, effects = "fixed") 13 | lmm_glance <- glance_performance(lmm_mod) 14 | 15 | expect_snapshot(lmm_tidy) 16 | expect_snapshot(lmm_glance) 17 | 18 | # lm 19 | set.seed(123) 20 | lm_mod <- lm(Reaction ~ Days, sleepstudy) 21 | lm_tidy <- tidy_parameters(lm_mod, vcov = TRUE) 22 | lm_glance <- glance_performance(lm_mod) 23 | 24 | expect_snapshot(lm_tidy) 25 | expect_snapshot(lm_glance) 26 | 27 | # setup 28 | set.seed(123) 29 | library(lavaan) 30 | 31 | # model specs 32 | HS.model <- " visual =~ x1 + x2 + x3 33 | textual =~ x4 + x5 + x6 34 | speed =~ x7 + x8 + x9 " 35 | 36 | # model 37 | mod_lavaan <- 38 | lavaan( 39 | HS.model, 40 | data = HolzingerSwineford1939, 41 | auto.var = TRUE, 42 | auto.fix.first = TRUE, 43 | auto.cov.lv.x = TRUE 44 | ) 45 | 46 | # test 47 | expect_identical( 48 | tidy_parameters(mod_lavaan, effects = "fixed"), 49 | tidy_parameters(mod_lavaan, effects = "fixed", exponentiate = TRUE) 50 | ) 51 | 52 | # model (not covered by easystats but covered by broom) 53 | expect_equal( 54 | dim(suppressWarnings(broomExtra::tidy_parameters(acf(lh, plot = FALSE)))), 55 | c(17L, 2L) 56 | ) 57 | 58 | # where functions are not supposed to work 59 | expect_null(suppressWarnings(broomExtra::glance_performance(acf(lh, plot = FALSE)))) 60 | expect_null(broomExtra::tidy_parameters(list(1, c("x", "y")), verbose = FALSE)) 61 | } 62 | ) 63 | -------------------------------------------------------------------------------- /tests/testthat/test-generics.R: -------------------------------------------------------------------------------- 1 | # `tidy()` works ------------------------------------------------------ 2 | 3 | test_that( 4 | desc = "`tidy()` works", 5 | code = { 6 | library(lme4) 7 | set.seed(123) 8 | 9 | # broom.mixed 10 | lmm.mod <- lmer(Reaction ~ Days + (Days | Subject), sleepstudy) 11 | expect_equal( 12 | broomExtra::tidy(lmm.mod), broom.mixed::tidy(lmm.mod) 13 | ) 14 | 15 | # broom 16 | lm.mod <- lm(Reaction ~ Days, sleepstudy) 17 | expect_equal(broomExtra::tidy(lm.mod), broom::tidy(lm.mod)) 18 | } 19 | ) 20 | 21 | # `glance()` works ------------------------------------------------------ 22 | 23 | test_that( 24 | desc = "`glance()` works", 25 | code = { 26 | library(lme4) 27 | set.seed(123) 28 | 29 | # broom.mixed 30 | lmm.mod <- lmer(Reaction ~ Days + (Days | Subject), sleepstudy) 31 | expect_equal( 32 | broomExtra::glance(lmm.mod), broom.mixed::glance(lmm.mod) 33 | ) 34 | 35 | # broom 36 | lm.mod <- lm(Reaction ~ Days, sleepstudy) 37 | expect_equal(broomExtra::glance(lm.mod), broom::glance(lm.mod)) 38 | 39 | # unsupported 40 | x <- c(2, 2:4, 4, 4, 5, 5, 7, 7, 7) 41 | y <- c(1:6, 5:4, 3:1) 42 | suppressWarnings(appr <- stats::approx(x, y, xout = x)) 43 | expect_null(broomExtra::glance(appr)) 44 | } 45 | ) 46 | 47 | # `augment()` works ------------------------------------------------------ 48 | 49 | test_that( 50 | desc = "`augment()` works", 51 | code = { 52 | library(lme4) 53 | set.seed(123) 54 | 55 | # broom.mixed 56 | lmm.mod <- lmer(Reaction ~ Days + (Days | Subject), sleepstudy) 57 | expect_equal( 58 | broomExtra::augment(lmm.mod), broom.mixed::augment(lmm.mod) 59 | ) 60 | 61 | # broom 62 | lm.mod <- lm(Reaction ~ Days, sleepstudy) 63 | expect_equal(broomExtra::augment(lm.mod), broom::augment(lm.mod)) 64 | 65 | # unsupported 66 | expect_null( 67 | broomExtra::augment(stats::anova(stats::lm(wt ~ am, mtcars))) 68 | ) 69 | } 70 | ) 71 | -------------------------------------------------------------------------------- /.github/SUPPORT.md: -------------------------------------------------------------------------------- 1 | # Getting help with broomExtra 2 | 3 | Thanks for using broomExtra. Before filing an issue, there are a few places 4 | to explore and pieces to put together to make the process as smooth as possible. 5 | 6 | Start by making a minimal **repr**oducible **ex**ample using the 7 | [reprex](https://reprex.tidyverse.org/) package. If you haven't heard of or used 8 | reprex before, you're in for a treat! Seriously, reprex will make all of your 9 | R-question-asking endeavors easier (which is a pretty insane ROI for the five to 10 | ten minutes it'll take you to learn what it's all about). For additional reprex 11 | pointers, check out the [Get help!](https://www.tidyverse.org/help/) section of 12 | the tidyverse site. 13 | 14 | Armed with your reprex, the next step is to figure out [where to ask](https://www.tidyverse.org/help/#where-to-ask). 15 | 16 | * If it's a question: start with [community.rstudio.com](https://community.rstudio.com/), 17 | and/or StackOverflow. There are more people there to answer questions. 18 | * If it's a bug: you're in the right place, file an issue. 19 | * If you're not sure: let the community help you figure it out! If your 20 | problem _is_ a bug or a feature request, you can easily return here and 21 | report it. 22 | 23 | Before opening a new issue, be sure to [search issues and pull requests](https://github.com/tidyverse/broomExtra/issues) to make sure the 24 | bug hasn't been reported and/or already fixed in the development version. By 25 | default, the search will be pre-populated with `is:issue is:open`. You can 26 | [edit the qualifiers](https://help.github.com/articles/searching-issues-and-pull-requests/) 27 | (e.g. `is:pr`, `is:closed`) as needed. For example, you'd simply 28 | remove `is:open` to search _all_ issues in the repo, open or closed. 29 | 30 | 31 | If you _are_ in the right place, and need to file an issue, please review the 32 | ["File issues"](https://www.tidyverse.org/contribute/#issues) paragraph from 33 | the tidyverse contributing guidelines. 34 | 35 | Thanks for your help! 36 | -------------------------------------------------------------------------------- /tests/testthat/_snaps/hybrid_generics.md: -------------------------------------------------------------------------------- 1 | # hybrid methods works 2 | 3 | Code 4 | lmm_tidy 5 | Output 6 | # A tibble: 2 x 10 7 | term estimate std.error conf.level conf.low conf.high statistic 8 | 9 | 1 (Intercept) 251. 6.82 0.95 238. 265. 36.8 10 | 2 Days 10.5 1.55 0.95 7.42 13.5 6.77 11 | df.error p.value effect 12 | 13 | 1 174 4.37e-84 fixed 14 | 2 174 1.88e-10 fixed 15 | 16 | --- 17 | 18 | Code 19 | lmm_glance 20 | Output 21 | # A tibble: 1 x 12 22 | nobs sigma loglik aic bic remlcrit df.residual aicc r2.conditional 23 | 24 | 1 180 25.6 -872. 1756. 1775. 1744. 174 1756. 0.799 25 | r2.marginal icc rmse 26 | 27 | 1 0.279 0.722 23.4 28 | 29 | --- 30 | 31 | Code 32 | lm_tidy 33 | Output 34 | # A tibble: 2 x 9 35 | term estimate std.error conf.level conf.low conf.high statistic 36 | 37 | 1 (Intercept) 251. 6.61 0.95 238. 264. 38.0 38 | 2 Days 10.5 1.24 0.95 8.02 12.9 8.45 39 | df.error p.value 40 | 41 | 1 178 2.16e-87 42 | 2 178 9.89e-15 43 | 44 | --- 45 | 46 | Code 47 | lm_glance 48 | Output 49 | # A tibble: 1 x 13 50 | r.squared adj.r.squared sigma statistic p.value df loglik aic bic 51 | 52 | 1 0.286 0.282 47.7 71.5 9.89e-15 1 -950. 1906. 1916. 53 | deviance df.residual nobs rmse 54 | 55 | 1 405252. 178 180 47.4 56 | 57 | -------------------------------------------------------------------------------- /.github/workflows/check-full.yaml: -------------------------------------------------------------------------------- 1 | # Workflow derived from https://github.com/r-lib/actions/tree/master/examples 2 | # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help 3 | 4 | on: 5 | push: 6 | branches: [main, master] 7 | pull_request: 8 | branches: [main, master] 9 | 10 | name: R-CMD-check 11 | 12 | jobs: 13 | R-CMD-check: 14 | runs-on: ${{ matrix.config.os }} 15 | 16 | name: ${{ matrix.config.os }} (${{ matrix.config.r }}) 17 | 18 | strategy: 19 | fail-fast: false 20 | matrix: 21 | config: 22 | #- {os: macOS-latest, r: 'devel'} 23 | - {os: macOS-latest, r: 'release'} 24 | - {os: macOS-latest, r: 'oldrel-1'} 25 | 26 | - {os: windows-latest, r: 'devel', rtools-version: '42'} 27 | - {os: windows-latest, r: 'devel'} 28 | - {os: windows-latest, r: 'release'} 29 | - {os: windows-latest, r: 'oldrel-1'} 30 | 31 | #- {os: ubuntu-18.04, r: 'devel', http-user-agent: 'release'} 32 | - {os: ubuntu-18.04, r: 'release'} 33 | - {os: ubuntu-18.04, r: 'oldrel-1'} 34 | 35 | env: 36 | GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} 37 | R_KEEP_PKG_SOURCE: yes 38 | 39 | steps: 40 | - uses: actions/checkout@v2 41 | 42 | - uses: r-lib/actions/setup-pandoc@master 43 | 44 | - uses: r-lib/actions/setup-r@master 45 | with: 46 | r-version: ${{ matrix.config.r }} 47 | rtools-version: ${{ matrix.config.rtools-version }} 48 | http-user-agent: ${{ matrix.config.http-user-agent }} 49 | use-public-rspm: true 50 | 51 | - uses: r-lib/actions/setup-r-dependencies@master 52 | with: 53 | extra-packages: rcmdcheck 54 | 55 | - uses: r-lib/actions/check-r-package@master 56 | 57 | - name: Show testthat output 58 | if: always() 59 | run: find check -name 'testthat.Rout*' -exec cat '{}' \; || true 60 | shell: bash 61 | 62 | - name: Upload check results 63 | if: failure() 64 | uses: actions/upload-artifact@main 65 | with: 66 | name: ${{ runner.os }}-r${{ matrix.config.r }}-results 67 | path: check 68 | -------------------------------------------------------------------------------- /.github/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to broomExtra 2 | 3 | This outlines how to propose a change to broomExtra. For more detailed 4 | info about contributing to this, and other tidyverse packages, please see the 5 | [**development contributing guide**](https://rstd.io/tidy-contrib). 6 | 7 | ### Fixing typos 8 | 9 | Small typos or grammatical errors in documentation may be edited directly using 10 | the GitHub web interface, so long as the changes are made in the _source_ file. 11 | 12 | * YES: you edit a roxygen comment in a `.R` file below `R/`. 13 | * NO: you edit an `.Rd` file below `man/`. 14 | 15 | ### Prerequisites 16 | 17 | Before you make a substantial pull request, you should always file an issue and 18 | make sure someone from the team agrees that it’s a problem. If you’ve found a 19 | bug, create an associated issue and illustrate the bug with a minimal 20 | [reprex](https://www.tidyverse.org/help/#reprex). 21 | 22 | ### Pull request process 23 | 24 | * We recommend that you create a Git branch for each pull request (PR). 25 | * Look at the Travis and AppVeyor build status before and after making changes. 26 | The `README` should contain badges for any continuous integration services used 27 | by the package. 28 | * New code should follow the tidyverse [style guide](http://style.tidyverse.org). 29 | You can use the [styler](https://CRAN.R-project.org/package=styler) package to 30 | apply these styles, but please don't restyle code that has nothing to do with 31 | your PR. 32 | * We use [roxygen2](https://cran.r-project.org/package=roxygen2), with 33 | [Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/markdown.html), 34 | for documentation. 35 | * We use [testthat](https://cran.r-project.org/package=testthat). Contributions 36 | with test cases included are easier to accept. 37 | * For user-facing changes, add a bullet to the top of `NEWS.md` below the 38 | current development version header describing the changes made followed by your 39 | GitHub username, and links to relevant issue(s)/PR(s). 40 | 41 | ### Code of Conduct 42 | 43 | Please note that the broomExtra project is released with a 44 | [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this 45 | project you agree to abide by its terms. 46 | 47 | ### See tidyverse [development contributing guide](https://rstd.io/tidy-contrib) 48 | for further details. 49 | -------------------------------------------------------------------------------- /tests/testthat/_snaps/grouped_generics.md: -------------------------------------------------------------------------------- 1 | # `grouped_tidy()` works 2 | 3 | Code 4 | list(lmer_df, lm_df) 5 | Output 6 | [[1]] 7 | # A tibble: 8 x 9 8 | sex effect group term estimate std.error statistic conf.low 9 | 10 | 1 F fixed (Intercept) 623. 161. 3.88 209. 11 | 2 F fixed age -4.34 2.61 -1.66 -11.1 12 | 3 F ran_pars status sd__(Intercept) 169. NA NA NA 13 | 4 F ran_pars Residual sd__Observation 415. NA NA NA 14 | 5 M fixed (Intercept) 553. 62.5 8.84 392. 15 | 6 M fixed age -3.60 0.696 -5.17 -5.39 16 | 7 M ran_pars status sd__(Intercept) 79.8 NA NA NA 17 | 8 M ran_pars Residual sd__Observation 355. NA NA NA 18 | conf.high 19 | 20 | 1 1037. 21 | 2 2.38 22 | 3 NA 23 | 4 NA 24 | 5 714. 25 | 6 -1.80 26 | 7 NA 27 | 8 NA 28 | 29 | [[2]] 30 | # A tibble: 4 x 8 31 | sex term estimate std.error statistic p.value conf.low conf.high 32 | 33 | 1 F (Intercept) 668. 110. 6.08 3.09e- 8 379. 957. 34 | 2 F age -6.06 2.61 -2.32 2.26e- 2 -12.9 0.815 35 | 3 M (Intercept) 547. 27.2 20.1 4.68e-84 477. 617. 36 | 4 M age -3.80 0.704 -5.40 7.38e- 8 -5.61 -1.98 37 | 38 | 39 | # `grouped_glance()` works 40 | 41 | Code 42 | list(lmer_df, lm_df) 43 | Output 44 | [[1]] 45 | # A tibble: 2 x 8 46 | sex nobs sigma logLik AIC BIC REMLcrit df.residual 47 | 48 | 1 F 89 415. -656. 1321. 1331. 1313. 85 49 | 2 M 2754 355. -20079. 40165. 40189. 40157. 2750 50 | 51 | [[2]] 52 | # A tibble: 2 x 13 53 | sex r.squared adj.r.squared sigma statistic p.value df logLik 54 | 55 | 1 F 0.0583 0.0475 431. 5.39 0.0226 1 -665. 56 | 2 M 0.0105 0.0101 359. 29.1 0.0000000738 1 -20112. 57 | AIC BIC deviance df.residual nobs 58 | 59 | 1 1336. 1344. 16139909. 87 89 60 | 2 40231. 40249. 355441032. 2752 2754 61 | 62 | 63 | -------------------------------------------------------------------------------- /tests/testthat/test-grouped_generics.R: -------------------------------------------------------------------------------- 1 | # `grouped_tidy()` works ------------------------------------------------------ 2 | 3 | test_that( 4 | desc = "`grouped_tidy()` works", 5 | code = { 6 | options(tibble.width = Inf) 7 | library(lme4) 8 | 9 | # broom.mixed 10 | set.seed(123) 11 | lmer_df <- 12 | broomExtra::grouped_tidy( 13 | data = mutate(MASS::Aids2, interval = death - diag), 14 | grouping.vars = sex, 15 | ..f = lme4::lmer, 16 | formula = interval ~ age + (1 | status), 17 | control = lme4::lmerControl(optimizer = "bobyqa"), 18 | tidy.args = list(conf.int = TRUE, conf.level = 0.99) 19 | ) 20 | 21 | # broom 22 | set.seed(123) 23 | lm_df <- 24 | broomExtra::grouped_tidy( 25 | data = mutate(MASS::Aids2, interval = death - diag), 26 | grouping.vars = sex, 27 | ..f = stats::lm, 28 | formula = interval ~ age, 29 | tidy.args = list(conf.int = TRUE, conf.level = 0.99) 30 | ) 31 | 32 | expect_snapshot(list(lmer_df, lm_df)) 33 | } 34 | ) 35 | 36 | # `grouped_glance()` works ------------------------------------------------------ 37 | 38 | test_that( 39 | desc = "`grouped_glance()` works", 40 | code = { 41 | library(lme4) 42 | set.seed(123) 43 | 44 | # broom.mixed 45 | set.seed(123) 46 | lmer_df <- 47 | broomExtra::grouped_glance( 48 | data = mutate(MASS::Aids2, interval = death - diag), 49 | grouping.vars = sex, 50 | ..f = lme4::lmer, 51 | formula = interval ~ age + (1 | status), 52 | control = lme4::lmerControl(optimizer = "bobyqa") 53 | ) 54 | 55 | # broom 56 | set.seed(123) 57 | lm_df <- 58 | broomExtra::grouped_glance( 59 | data = mutate(MASS::Aids2, interval = death - diag), 60 | grouping.vars = sex, 61 | ..f = stats::lm, 62 | formula = interval ~ age 63 | ) 64 | 65 | expect_snapshot(list(lmer_df, lm_df)) 66 | } 67 | ) 68 | 69 | # `grouped_augment()` works ------------------------------------------------------ 70 | 71 | test_that( 72 | desc = "`grouped_augment()` works", 73 | code = { 74 | library(lme4) 75 | 76 | # broom.mixed 77 | set.seed(123) 78 | lmer_df <- 79 | broomExtra::grouped_augment( 80 | data = mutate(MASS::Aids2, interval = death - diag), 81 | grouping.vars = sex, 82 | ..f = lme4::lmer, 83 | formula = interval ~ age + (1 | status), 84 | control = lme4::lmerControl(optimizer = "bobyqa") 85 | ) 86 | 87 | # broom 88 | set.seed(123) 89 | lm_df <- 90 | broomExtra::grouped_augment( 91 | data = mutate(MASS::Aids2, interval = death - diag), 92 | grouping.vars = sex, 93 | ..f = stats::lm, 94 | formula = interval ~ age 95 | ) 96 | 97 | expect_equal(dim(lmer_df)[1], 2843L) 98 | expect_equal(dim(lm_df)[1], 2843L) 99 | } 100 | ) 101 | -------------------------------------------------------------------------------- /R/generics.R: -------------------------------------------------------------------------------- 1 | #' @title Retrieve tidy dataframe if it exists 2 | #' @name tidy 3 | #' 4 | #' @description 5 | #' 6 | #' Checks if a `tidy` method exits for a given object, either in `{broom}` or in 7 | #' `{broom.mixed}`. If it does, it turn an object into a tidy tibble, if not, 8 | #' return a `NULL`. In this case, you can try the 9 | #' [broomExtra::tidy_parameters()] function. 10 | #' 11 | #' @inheritParams generics::tidy 12 | #' 13 | #' @inherit generics::tidy return value 14 | #' 15 | #' @seealso \code{\link{grouped_tidy}}, \code{\link{tidy_parameters}} 16 | #' 17 | #' @examples 18 | #' set.seed(123) 19 | #' lm.mod <- lm(Sepal.Length ~ Species, iris) 20 | #' broomExtra::tidy(x = lm.mod, conf.int = TRUE) 21 | #' @export 22 | 23 | tidy <- function(x, ...) { 24 | # check if `{broom}` has a tidy method for a given object 25 | f <- tryCatch(broom::tidy(x, ...), error = function(e) NULL) 26 | 27 | # if not, check if `{broom.mixed}` has a tidy method for a given object 28 | if (is_null(f)) f <- tryCatch(broom.mixed::tidy(x, ...), error = function(e) NULL) 29 | 30 | # return the tidy 31 | return(f) 32 | } 33 | 34 | 35 | #' @title Retrieve model summary dataframe if it exists. 36 | #' @name glance 37 | #' 38 | #' @description 39 | #' 40 | #' Checks if a `glance` method exits for a given object, either in `{broom}` or in 41 | #' `{broom.mixed}`. If it does, return the model summary dataframe, if not, return 42 | #' a `NULL`. In this case, you can try the [broomExtra::glance_performance()] 43 | #' function. 44 | #' 45 | #' @inheritParams generics::glance 46 | #' 47 | #' @inherit generics::glance return value 48 | #' 49 | #' @seealso \code{\link{grouped_glance}}, \code{\link{glance_performance}} 50 | #' 51 | #' @examples 52 | #' set.seed(123) 53 | #' lm.mod <- lm(Sepal.Length ~ Species, iris) 54 | #' broomExtra::glance(lm.mod) 55 | #' @export 56 | 57 | glance <- function(x, ...) { 58 | # check if `{broom}` has a glance method for a given object 59 | f <- tryCatch(broom::glance(x, ...), error = function(e) NULL) 60 | 61 | # if not, check if `{broom.mixed}` has a glance method for a given object 62 | if (is_null(f)) f <- tryCatch(broom.mixed::glance(x, ...), error = function(e) NULL) 63 | 64 | # return the glance 65 | return(f) 66 | } 67 | 68 | #' @title Retrieve augmented dataframe if it exists. 69 | #' @name augment 70 | #' @description 71 | #' 72 | #' Checks if a `augment` method exits for a given object, either in `{broom}` or 73 | #' in `{broom.mixed}`. If it does, return the model summary dataframe, if not, 74 | #' return a `NULL`. 75 | #' 76 | #' @inheritParams generics::augment 77 | #' 78 | #' @inherit generics::augment return value 79 | #' 80 | #' @seealso \code{\link{grouped_augment}} 81 | #' 82 | #' @examples 83 | #' set.seed(123) 84 | #' lm.mod <- lm(Sepal.Length ~ Species, iris) 85 | #' broomExtra::augment(lm.mod) 86 | #' @export 87 | 88 | augment <- function(x, ...) { 89 | # check if `{broom}` has a augment method for a given object 90 | f <- tryCatch(broom::augment(x, ...), error = function(e) NULL) 91 | 92 | # if not, check if `{broom.mixed}` has a augment method for a given object 93 | if (is_null(f)) f <- tryCatch(broom.mixed::augment(x, ...), error = function(e) NULL) 94 | 95 | # return the augment 96 | return(f) 97 | } 98 | -------------------------------------------------------------------------------- /NEWS.md: -------------------------------------------------------------------------------- 1 | # broomExtra 5.0.0 2 | 3 | - Archived on CRAN and deprecated in favour of [easystats](https://easystats.github.io/easystats/) project. 4 | 5 | # broomExtra 4.3.2 6 | 7 | - Fixes tests for `{performance}` package update. 8 | 9 | # broomExtra 4.3.1 10 | 11 | - Fixes tests for `{broom.mixed}` package update. 12 | 13 | # broomExtra 4.3.0 14 | 15 | - Bumps needed `{easystats}` package versions. 16 | 17 | - `{rlang}` operators are no longer re-exported. 18 | 19 | # broomExtra 4.2.3 20 | 21 | - Removes `NOTE` about `LazyData` in CRAN's daily checks. 22 | 23 | # broomExtra 4.2.1 24 | 25 | - Removes `lifecycle` from `Imports` to get rid of `NOTE` in CRAN daily 26 | checks. 27 | 28 | # broomExtra 4.2.0 29 | 30 | - The tests are no longer skipped on `CRAN`. 31 | 32 | # broomExtra 4.1.0 33 | 34 | - `...` are now passed to individual methods in `glance_performance`. 35 | 36 | - Removes `ipmisc` from dependencies. 37 | 38 | # broomExtra 4.0.6 39 | 40 | - Minor tweak to the documentation. 41 | 42 | - `easystats_to_tidy_names` is now reexported from `ipmisc`. 43 | 44 | # broomExtra 4.0.5 45 | 46 | - More comprehensive coverage of terms from `easystats` packages. 47 | 48 | # broomExtra 4.0.4 49 | 50 | - Adapts tests to changes made to `parameters` package. 51 | 52 | # broomExtra 4.0.3 53 | 54 | - Minor release to fix `NOTE` produced in new `R`-devel checks. 55 | 56 | # broomExtra 4.0.2 57 | 58 | - Minor changes made to fix warnings caused by `dplyr 1.0.0`. 59 | 60 | - Retired vignette. Check out respective packages to see what methods are 61 | supported. 62 | 63 | # broomExtra 4.0.0 64 | 65 | - The `broom` package is not being actively maintained, which had become a 66 | bottleneck for both development and testing the current package. So, now the 67 | `tidy_parameters` function defaults to `parameters::model_parameters` and 68 | uses `broom` packages only if that doesn't work. This also has some other 69 | benefits (#21). 70 | 71 | # broomExtra 3.0.0 72 | 73 | - Slight modification to `easystats_to_tidy_names` to cover naming patterns 74 | from a few more `easystats` packages. 75 | 76 | - Minimum R version bumped to `3.6.0`. 77 | 78 | - Relies on `ipmisc` package for re-exports. 79 | 80 | # broomExtra 2.5.0 81 | 82 | - The `glance_performance` function now returns a combined summary dataframe 83 | from `broom` and `performance` packages, if both are available. This was 84 | done to include some unique performance measures that only the `performance` 85 | package contains (e.g., Nagelkerke's $R^2$, Tjur's $R^2$, etc.). 86 | 87 | - Thanks to Sarah, the package now has a hexsticker. 88 | 89 | # broomExtra 2.0.0 90 | 91 | - New functions that make it easy to access tidy dataframes from both 92 | `broom`-family and `easystats`-family packages with the following functions: 93 | `tidy_parameters` and `glance_performance`. 94 | 95 | - `tidy` method no longer attempt to convert entered objects to a tibble as a 96 | last resort as this was converting model objects in case the tidiers failed 97 | for some reason. 98 | 99 | # broomExtra 1.0.1 100 | 101 | - Minor internal refactoring of code. 102 | 103 | # broomExtra 1.0.0 104 | 105 | - Deprecated `boot_` functions as they added nothing over and above 106 | `rsample`. 107 | 108 | # broomExtra 0.0.6 109 | 110 | - Maintenance release to make package compatible with `dplyr 0.8.4`. 111 | 112 | # broomExtra 0.0.5 113 | 114 | - In addition to trying to extract results using tidiers from `broom` and 115 | `broom.mixed`, `broomExtra::tidy` now also attempts to convert the entered 116 | object into a `tibble` dataframe. This is solely to deal with dataframes 117 | which are often encountered while writing wrapper functions around `tidy`. 118 | 119 | - Minor refactoring of `boot_` generic functions to make them compatible with 120 | upcoming release of `tidyr`. 121 | 122 | - More operators from `tidyverse` added to reexports. 123 | 124 | # broomExtra 0.0.4 125 | 126 | - Adds new functions for bootstrapping: `boot_tidy`, `boot_glance`, 127 | `boot_augment`. 128 | 129 | # broomExtra 0.0.3 130 | 131 | - This is maintenance release to make the package compatible with `R 3.6.0`. 132 | 133 | # broomExtra 0.0.2 134 | 135 | - This is maintenance release to make the package compatible with `dplyr 136 | 0.8.1`. 137 | 138 | # broomExtra 0.0.1 139 | 140 | - Initial release. 141 | 142 | -------------------------------------------------------------------------------- /R/hybrid_easystats.R: -------------------------------------------------------------------------------- 1 | #' @name tidy_parameters 2 | #' @title Tidy dataframes of model parameters using `{broom}` and `{easystats}` 3 | #' 4 | #' @description 5 | #' 6 | #' Computes parameters for regression models. 7 | #' 8 | #' @details The function will attempt to get these details first using 9 | #' [parameters::model_parameters()], and if this fails, then using 10 | #' [broom::tidy()]. 11 | #' 12 | #' @inheritParams tidy 13 | #' @param conf.int Indicating whether or not to include a confidence interval in 14 | #' the tidied output (defaults to `TRUE`). 15 | #' @param ... Additional arguments that will be passed to 16 | #' [parameters::model_parameters()] or [broom::tidy()], whichever method 17 | #' works. Note that you should pay attention to different naming conventions 18 | #' across these packages. For example, the required confidence interval width 19 | #' is specified using `ci` argument in `parameters::model_parameters`, while 20 | #' using `conf.level` in `broom::tidy`. 21 | #' 22 | #' @return A data frame of indices related to the model's parameters. 23 | #' 24 | #' @examples 25 | #' set.seed(123) 26 | #' mod <- lm(mpg ~ wt + cyl, data = mtcars) 27 | #' broomExtra::tidy_parameters(mod) 28 | #' @import parameters 29 | #' 30 | #' @export 31 | 32 | tidy_parameters <- function(x, conf.int = TRUE, ...) { 33 | # easystats family --------------------------------------- 34 | 35 | # check if `{easystats}` family has a tidy method for a given object 36 | m <- tryCatch( 37 | expr = standardize_names(model_parameters(x, ...), style = "broom"), 38 | error = function(e) NULL 39 | ) 40 | 41 | 42 | if (is_null(m)) { 43 | m <- tryCatch( 44 | expr = standardize_names(model_parameters(x), style = "broom"), 45 | error = function(e) NULL 46 | ) 47 | } 48 | 49 | # broom family -------------------------------------------- 50 | 51 | # check if `{broom}` family has a tidy method for a given object 52 | if (is_null(m)) { 53 | m <- tryCatch( 54 | expr = broomExtra::tidy(x, conf.int = conf.int, ...), 55 | error = function(e) NULL 56 | ) 57 | } 58 | 59 | # return the final object 60 | if (is_null(m)) m else as_tibble(m) 61 | } 62 | 63 | 64 | #' @name glance_performance 65 | #' @title Model performance summary dataframes using `{broom}` and `{easystats}` 66 | #' 67 | #' @description 68 | #' 69 | #' Computes indices of model performance for regression models. 70 | #' 71 | #' @return A data frame (with one row) and one column per "index". 72 | #' 73 | #' @details The function will attempt to get these details either using 74 | #' [broom::glance()] or [performance::model_performance()]. If both function 75 | #' provide model performance measure summaries, the function will try to 76 | #' combine them into a single dataframe. Measures for which these two packages 77 | #' have different naming conventions, both will be retained. 78 | #' 79 | #' @inheritParams glance 80 | #' 81 | #' @examples 82 | #' 83 | #' set.seed(123) 84 | #' mod <- lm(mpg ~ wt + cyl, data = mtcars) 85 | #' broomExtra::glance_performance(mod) 86 | #' @import performance 87 | #' 88 | #' @export 89 | 90 | glance_performance <- function(x, ...) { 91 | # broom family -------------------------------------------- 92 | # check if `{broom}` family has a tidy method for a given object 93 | df_broom <- tryCatch(broomExtra::glance(x, ...), error = function(e) NULL) 94 | 95 | # for consistency with `{performance}` output, convert column names to lowercase 96 | if (!is_null(df_broom)) df_broom %<>% rename_all(.funs = tolower) 97 | 98 | # easystats family --------------------------------------- 99 | # check if `{easystats}` family has a tidy method for a given object 100 | df_performance <- tryCatch( 101 | expr = standardize_names(model_performance(x, metrics = "all", ...), style = "broom"), 102 | error = function(e) NULL 103 | ) 104 | 105 | # marry the families --------------------------------------- 106 | # combine if both are available 107 | if (!is_null(df_broom) && !is_null(df_performance)) { 108 | df_combined <- bind_cols( 109 | df_broom, 110 | select(df_performance, -intersect(names(df_broom), names(df_performance))), 111 | ) 112 | } 113 | 114 | # otherwise return what's not a `NULL` 115 | if (is_null(df_broom)) df_combined <- df_performance 116 | if (is_null(df_performance)) df_combined <- df_broom 117 | 118 | # return the final object 119 | if (is_null(df_combined)) df_combined else as_tibble(df_combined) 120 | } 121 | -------------------------------------------------------------------------------- /R/grouped_generics.R: -------------------------------------------------------------------------------- 1 | #' @title Grouped tidy analysis 2 | #' @description Tidy output from grouped analysis of any function that has 3 | #' `data` argument in its function call 4 | #' @name grouped_tidy 5 | #' 6 | #' @param data Dataframe (or tibble) from which variables are to be taken. 7 | #' @param grouping.vars Grouping variables. 8 | #' @param ..f A function, or function name as a string. 9 | #' @inheritParams rlang::exec 10 | #' @param tidy.args A list of arguments to be used in the relevant `S3` method. 11 | #' 12 | #' @import rlang 13 | #' @import dplyr 14 | #' 15 | #' @inherit tidy return value 16 | #' 17 | #' @seealso \code{\link{tidy}} 18 | #' 19 | #' @examples 20 | #' set.seed(123) 21 | #' library(dplyr) 22 | #' 23 | #' # linear mixed effects model 24 | #' grouped_tidy( 25 | #' data = mutate(MASS::Aids2, interval = death - diag), 26 | #' grouping.vars = sex, 27 | #' ..f = lme4::lmer, 28 | #' formula = interval ~ age + (1 | status), 29 | #' control = lme4::lmerControl(optimizer = "bobyqa"), 30 | #' tidy.args = list(conf.int = TRUE, conf.level = 0.99) 31 | #' ) 32 | #' @export 33 | 34 | # function body 35 | grouped_tidy <- function(data, 36 | grouping.vars, 37 | ..f, 38 | ..., 39 | tidy.args = list()) { 40 | # functions passed to `group_modify` must accept 41 | # `.x` and `.y` arguments, where `.x` is the data 42 | tidy_group <- function(.x, .y) { 43 | # presumes `..f` will work with these args 44 | model <- ..f(.y = ..., data = .x) 45 | 46 | # variation on `do.call` to call function with list of arguments 47 | exec(broomExtra::tidy, model, !!!tidy.args) 48 | } 49 | 50 | # dataframe with grouped analysis results 51 | grouped_cleanup(data, enquos(grouping.vars), tidy_group) 52 | } 53 | 54 | #' @title Grouped model summary 55 | #' @description Model summary output from grouped analysis of any function that 56 | #' has `data` argument in its function call. 57 | #' @name grouped_glance 58 | #' 59 | #' @inheritParams grouped_tidy 60 | #' 61 | #' @inherit glance return value 62 | #' 63 | #' @seealso \code{\link{glance}} 64 | #' 65 | #' @examples 66 | #' set.seed(123) 67 | #' library(dplyr) 68 | #' 69 | #' # linear mixed effects model 70 | #' grouped_glance( 71 | #' data = mutate(MASS::Aids2, interval = death - diag), 72 | #' grouping.vars = sex, 73 | #' ..f = lme4::lmer, 74 | #' formula = interval ~ age + (1 | status), 75 | #' control = lme4::lmerControl(optimizer = "bobyqa") 76 | #' ) 77 | #' @export 78 | 79 | # function body 80 | grouped_glance <- function(data, 81 | grouping.vars, 82 | ..f, 83 | ...) { 84 | # functions passed to `group_modify` must accept 85 | # `.x` and `.y` arguments, where `.x` is the data 86 | glance_group <- function(.x, .y) { 87 | # presumes `..f` will work with these args 88 | model <- ..f(.y = ..., data = .x) 89 | 90 | # variation on `do.call` to call function with list of arguments 91 | exec(broomExtra::glance, model) 92 | } 93 | 94 | # dataframe with grouped analysis results 95 | grouped_cleanup(data, enquos(grouping.vars), glance_group) 96 | } 97 | 98 | #' @title Grouped augment 99 | #' @description Augmented data from grouped analysis of any function that has 100 | #' `data` argument in its function call. 101 | #' @name grouped_augment 102 | #' 103 | #' @inheritParams grouped_tidy 104 | #' @param augment.args A list of arguments to be used in the relevant `S3` method. 105 | #' 106 | #' @inherit augment return value 107 | #' 108 | #' @seealso \code{\link{augment}} 109 | #' 110 | #' @examples 111 | #' set.seed(123) 112 | #' library(dplyr) 113 | #' 114 | #' # linear mixed effects model 115 | #' grouped_augment( 116 | #' data = mutate(MASS::Aids2, interval = death - diag), 117 | #' grouping.vars = sex, 118 | #' ..f = lme4::lmer, 119 | #' formula = interval ~ age + (1 | status), 120 | #' control = lme4::lmerControl(optimizer = "bobyqa") 121 | #' ) 122 | #' @export 123 | 124 | # function body 125 | grouped_augment <- function(data, 126 | grouping.vars, 127 | ..f, 128 | ..., 129 | augment.args = list()) { 130 | # functions passed to `group_modify` must accept 131 | # `.x` and `.y` arguments, where `.x` is the data 132 | augment_group <- function(.x, .y) { 133 | # presumes `..f` will work with these args 134 | model <- ..f(.y = ..., data = .x) 135 | 136 | # variation on `do.call` to call function with list of arguments 137 | exec(broomExtra::augment, model, !!!augment.args) 138 | } 139 | 140 | # dataframe with grouped analysis results 141 | grouped_cleanup(data, enquos(grouping.vars), augment_group) 142 | } 143 | 144 | 145 | #' @noRd 146 | 147 | grouped_cleanup <- function(data, .vars, .f) { 148 | data %>% 149 | group_by_at(.vars, .drop = TRUE) %>% 150 | group_modify(.f) %>% 151 | ungroup() 152 | } 153 | -------------------------------------------------------------------------------- /.github/CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the overall 26 | community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards 42 | of acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies 54 | when an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail 56 | address, posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at patilindrajeet.science@gmail.com. 63 | All complaints will be reviewed and investigated promptly and fairly. 64 | 65 | All community leaders are obligated to respect the privacy and security of the 66 | reporter of any incident. 67 | 68 | ## Enforcement Guidelines 69 | 70 | Community leaders will follow these Community Impact Guidelines in determining 71 | the consequences for any action they deem in violation of this Code of Conduct: 72 | 73 | ### 1. Correction 74 | 75 | **Community Impact**: Use of inappropriate language or other behavior deemed 76 | unprofessional or unwelcome in the community. 77 | 78 | **Consequence**: A private, written warning from community leaders, providing 79 | clarity around the nature of the violation and an explanation of why the 80 | behavior was inappropriate. A public apology may be requested. 81 | 82 | ### 2. Warning 83 | 84 | **Community Impact**: A violation through a single incident or series of 85 | actions. 86 | 87 | **Consequence**: A warning with consequences for continued behavior. No 88 | interaction with the people involved, including unsolicited interaction with 89 | those enforcing the Code of Conduct, for a specified period of time. This 90 | includes avoiding interactions in community spaces as well as external channels 91 | like social media. Violating these terms may lead to a temporary or permanent 92 | ban. 93 | 94 | ### 3. Temporary Ban 95 | 96 | **Community Impact**: A serious violation of community standards, including 97 | sustained inappropriate behavior. 98 | 99 | **Consequence**: A temporary ban from any sort of interaction or public 100 | communication with the community for a specified period of time. No public or 101 | private interaction with the people involved, including unsolicited interaction 102 | with those enforcing the Code of Conduct, is allowed during this period. 103 | Violating these terms may lead to a permanent ban. 104 | 105 | ### 4. Permanent Ban 106 | 107 | **Community Impact**: Demonstrating a pattern of violation of community 108 | standards, including sustained inappropriate behavior, harassment of an 109 | individual, or aggression toward or disparagement of classes of individuals. 110 | 111 | **Consequence**: A permanent ban from any sort of public interaction within the 112 | community. 113 | 114 | ## Attribution 115 | 116 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 117 | version 2.0, 118 | available at . 119 | 120 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 121 | enforcement ladder](https://github.com/mozilla/diversity). 122 | 123 | [homepage]: https://www.contributor-covenant.org 124 | 125 | For answers to common questions about this code of conduct, see the FAQ at 126 | . Translations are available at . 127 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | ## `{broomExtra}`: Enhancement for `{broom}` and `{easystats}` 5 | 6 | [![lifecycle](https://img.shields.io/badge/lifecycle-deprecated-red.svg)](https://lifecycle.r-lib.org/articles/stages.html#deprecated) 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | This package has been archived on CRAN. Additionally, it is deprecated 27 | in favour of the [easystats](https://easystats.github.io/easystats/) 28 | project. 29 | 30 | The package can still be downloaded from GitHub: 31 | `pak::pak("IndrajeetPatil/broomExtra")` 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 | 186 | 187 | 188 | 189 | 190 | 191 | 192 | 193 | 194 | 195 | 196 | 197 | 198 | 199 | 200 | 201 | 202 | 203 | 204 | ## Acknowledgments 205 | 206 | The hexsticker was generously designed by Sarah Otterstetter (Max Planck 207 | Institute for Human Development, Berlin). Thanks are also due to the 208 | maintainers and contributors to `{broom}`- and `{easystats}`-package 209 | families who have indulged in all my feature requests! 210 | -------------------------------------------------------------------------------- /README.Rmd: -------------------------------------------------------------------------------- 1 | --- 2 | output: github_document 3 | --- 4 | 5 | 6 | 7 | ```{r, include = FALSE} 8 | knitr::opts_chunk$set( 9 | collapse = TRUE, 10 | comment = "#>" 11 | ) 12 | ``` 13 | 14 | ## `{broomExtra}`: Enhancement for `{broom}` and `{easystats}` 15 | 16 | [![lifecycle](https://img.shields.io/badge/lifecycle-deprecated-red.svg)](https://lifecycle.r-lib.org/articles/stages.html#deprecated) 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | This package has been archived on CRAN. Additionally, it is deprecated in favour of the [easystats](https://easystats.github.io/easystats/) project. 40 | 41 | The package can still be downloaded from GitHub: 42 | `pak::pak("IndrajeetPatil/broomExtra")` 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 | 186 | 187 | 188 | 189 | 190 | 191 | 192 | 193 | 194 | 195 | 196 | 197 | 198 | 199 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 210 | 211 | 212 | 213 | 214 | 215 | 216 | 217 | 218 | 219 | 220 | 221 | 222 | 223 | 224 | 225 | 226 | 227 | 228 | 229 | 230 | 231 | 232 | 233 | 234 | 235 | 236 | 237 | 238 | 239 | 240 | 241 | 242 | 243 | 244 | 245 | 246 | 247 | 248 | 249 | 250 | 251 | 252 | 253 | 254 | 255 | 256 | 257 | 258 | 259 | 260 | 261 | 262 | 263 | ## Acknowledgments 264 | 265 | The hexsticker was generously designed by Sarah Otterstetter (Max Planck 266 | Institute for Human Development, Berlin). Thanks are also due to the maintainers 267 | and contributors to `{broom}`- and `{easystats}`-package families who have indulged 268 | in all my feature requests! 269 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU General Public License 2 | ========================== 3 | 4 | _Version 3, 29 June 2007_ 5 | _Copyright © 2007 Free Software Foundation, Inc. <>_ 6 | 7 | Everyone is permitted to copy and distribute verbatim copies of this license 8 | document, but changing it is not allowed. 9 | 10 | ## Preamble 11 | 12 | The GNU General Public License is a free, copyleft license for software and other 13 | kinds of works. 14 | 15 | The licenses for most software and other practical works are designed to take away 16 | your freedom to share and change the works. By contrast, the GNU General Public 17 | License is intended to guarantee your freedom to share and change all versions of a 18 | program--to make sure it remains free software for all its users. We, the Free 19 | Software Foundation, use the GNU General Public License for most of our software; it 20 | applies also to any other work released this way by its authors. You can apply it to 21 | your programs, too. 22 | 23 | When we speak of free software, we are referring to freedom, not price. Our General 24 | Public Licenses are designed to make sure that you have the freedom to distribute 25 | copies of free software (and charge for them if you wish), that you receive source 26 | code or can get it if you want it, that you can change the software or use pieces of 27 | it in new free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you these rights or 30 | asking you to surrender the rights. Therefore, you have certain responsibilities if 31 | you distribute copies of the software, or if you modify it: responsibilities to 32 | respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether gratis or for a fee, 35 | you must pass on to the recipients the same freedoms that you received. You must make 36 | sure that they, too, receive or can get the source code. And you must show them these 37 | terms so they know their rights. 38 | 39 | Developers that use the GNU GPL protect your rights with two steps: **(1)** assert 40 | copyright on the software, and **(2)** offer you this License giving you legal permission 41 | to copy, distribute and/or modify it. 42 | 43 | For the developers' and authors' protection, the GPL clearly explains that there is 44 | no warranty for this free software. For both users' and authors' sake, the GPL 45 | requires that modified versions be marked as changed, so that their problems will not 46 | be attributed erroneously to authors of previous versions. 47 | 48 | Some devices are designed to deny users access to install or run modified versions of 49 | the software inside them, although the manufacturer can do so. This is fundamentally 50 | incompatible with the aim of protecting users' freedom to change the software. The 51 | systematic pattern of such abuse occurs in the area of products for individuals to 52 | use, which is precisely where it is most unacceptable. Therefore, we have designed 53 | this version of the GPL to prohibit the practice for those products. If such problems 54 | arise substantially in other domains, we stand ready to extend this provision to 55 | those domains in future versions of the GPL, as needed to protect the freedom of 56 | users. 57 | 58 | Finally, every program is threatened constantly by software patents. States should 59 | not allow patents to restrict development and use of software on general-purpose 60 | computers, but in those that do, we wish to avoid the special danger that patents 61 | applied to a free program could make it effectively proprietary. To prevent this, the 62 | GPL assures that patents cannot be used to render the program non-free. 63 | 64 | The precise terms and conditions for copying, distribution and modification follow. 65 | 66 | ## TERMS AND CONDITIONS 67 | 68 | ### 0. Definitions 69 | 70 | “This License” refers to version 3 of the GNU General Public License. 71 | 72 | “Copyright” also means copyright-like laws that apply to other kinds of 73 | works, such as semiconductor masks. 74 | 75 | “The Program” refers to any copyrightable work licensed under this 76 | License. Each licensee is addressed as “you”. “Licensees” and 77 | “recipients” may be individuals or organizations. 78 | 79 | To “modify” a work means to copy from or adapt all or part of the work in 80 | a fashion requiring copyright permission, other than the making of an exact copy. The 81 | resulting work is called a “modified version” of the earlier work or a 82 | work “based on” the earlier work. 83 | 84 | A “covered work” means either the unmodified Program or a work based on 85 | the Program. 86 | 87 | To “propagate” a work means to do anything with it that, without 88 | permission, would make you directly or secondarily liable for infringement under 89 | applicable copyright law, except executing it on a computer or modifying a private 90 | copy. Propagation includes copying, distribution (with or without modification), 91 | making available to the public, and in some countries other activities as well. 92 | 93 | To “convey” a work means any kind of propagation that enables other 94 | parties to make or receive copies. Mere interaction with a user through a computer 95 | network, with no transfer of a copy, is not conveying. 96 | 97 | An interactive user interface displays “Appropriate Legal Notices” to the 98 | extent that it includes a convenient and prominently visible feature that **(1)** 99 | displays an appropriate copyright notice, and **(2)** tells the user that there is no 100 | warranty for the work (except to the extent that warranties are provided), that 101 | licensees may convey the work under this License, and how to view a copy of this 102 | License. If the interface presents a list of user commands or options, such as a 103 | menu, a prominent item in the list meets this criterion. 104 | 105 | ### 1. Source Code 106 | 107 | The “source code” for a work means the preferred form of the work for 108 | making modifications to it. “Object code” means any non-source form of a 109 | work. 110 | 111 | A “Standard Interface” means an interface that either is an official 112 | standard defined by a recognized standards body, or, in the case of interfaces 113 | specified for a particular programming language, one that is widely used among 114 | developers working in that language. 115 | 116 | The “System Libraries” of an executable work include anything, other than 117 | the work as a whole, that **(a)** is included in the normal form of packaging a Major 118 | Component, but which is not part of that Major Component, and **(b)** serves only to 119 | enable use of the work with that Major Component, or to implement a Standard 120 | Interface for which an implementation is available to the public in source code form. 121 | A “Major Component”, in this context, means a major essential component 122 | (kernel, window system, and so on) of the specific operating system (if any) on which 123 | the executable work runs, or a compiler used to produce the work, or an object code 124 | interpreter used to run it. 125 | 126 | The “Corresponding Source” for a work in object code form means all the 127 | source code needed to generate, install, and (for an executable work) run the object 128 | code and to modify the work, including scripts to control those activities. However, 129 | it does not include the work's System Libraries, or general-purpose tools or 130 | generally available free programs which are used unmodified in performing those 131 | activities but which are not part of the work. For example, Corresponding Source 132 | includes interface definition files associated with source files for the work, and 133 | the source code for shared libraries and dynamically linked subprograms that the work 134 | is specifically designed to require, such as by intimate data communication or 135 | control flow between those subprograms and other parts of the work. 136 | 137 | The Corresponding Source need not include anything that users can regenerate 138 | automatically from other parts of the Corresponding Source. 139 | 140 | The Corresponding Source for a work in source code form is that same work. 141 | 142 | ### 2. Basic Permissions 143 | 144 | All rights granted under this License are granted for the term of copyright on the 145 | Program, and are irrevocable provided the stated conditions are met. This License 146 | explicitly affirms your unlimited permission to run the unmodified Program. The 147 | output from running a covered work is covered by this License only if the output, 148 | given its content, constitutes a covered work. This License acknowledges your rights 149 | of fair use or other equivalent, as provided by copyright law. 150 | 151 | You may make, run and propagate covered works that you do not convey, without 152 | conditions so long as your license otherwise remains in force. You may convey covered 153 | works to others for the sole purpose of having them make modifications exclusively 154 | for you, or provide you with facilities for running those works, provided that you 155 | comply with the terms of this License in conveying all material for which you do not 156 | control copyright. Those thus making or running the covered works for you must do so 157 | exclusively on your behalf, under your direction and control, on terms that prohibit 158 | them from making any copies of your copyrighted material outside their relationship 159 | with you. 160 | 161 | Conveying under any other circumstances is permitted solely under the conditions 162 | stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 163 | 164 | ### 3. Protecting Users' Legal Rights From Anti-Circumvention Law 165 | 166 | No covered work shall be deemed part of an effective technological measure under any 167 | applicable law fulfilling obligations under article 11 of the WIPO copyright treaty 168 | adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention 169 | of such measures. 170 | 171 | When you convey a covered work, you waive any legal power to forbid circumvention of 172 | technological measures to the extent such circumvention is effected by exercising 173 | rights under this License with respect to the covered work, and you disclaim any 174 | intention to limit operation or modification of the work as a means of enforcing, 175 | against the work's users, your or third parties' legal rights to forbid circumvention 176 | of technological measures. 177 | 178 | ### 4. Conveying Verbatim Copies 179 | 180 | You may convey verbatim copies of the Program's source code as you receive it, in any 181 | medium, provided that you conspicuously and appropriately publish on each copy an 182 | appropriate copyright notice; keep intact all notices stating that this License and 183 | any non-permissive terms added in accord with section 7 apply to the code; keep 184 | intact all notices of the absence of any warranty; and give all recipients a copy of 185 | this License along with the Program. 186 | 187 | You may charge any price or no price for each copy that you convey, and you may offer 188 | support or warranty protection for a fee. 189 | 190 | ### 5. Conveying Modified Source Versions 191 | 192 | You may convey a work based on the Program, or the modifications to produce it from 193 | the Program, in the form of source code under the terms of section 4, provided that 194 | you also meet all of these conditions: 195 | 196 | * **a)** The work must carry prominent notices stating that you modified it, and giving a 197 | relevant date. 198 | * **b)** The work must carry prominent notices stating that it is released under this 199 | License and any conditions added under section 7. This requirement modifies the 200 | requirement in section 4 to “keep intact all notices”. 201 | * **c)** You must license the entire work, as a whole, under this License to anyone who 202 | comes into possession of a copy. This License will therefore apply, along with any 203 | applicable section 7 additional terms, to the whole of the work, and all its parts, 204 | regardless of how they are packaged. This License gives no permission to license the 205 | work in any other way, but it does not invalidate such permission if you have 206 | separately received it. 207 | * **d)** If the work has interactive user interfaces, each must display Appropriate Legal 208 | Notices; however, if the Program has interactive interfaces that do not display 209 | Appropriate Legal Notices, your work need not make them do so. 210 | 211 | A compilation of a covered work with other separate and independent works, which are 212 | not by their nature extensions of the covered work, and which are not combined with 213 | it such as to form a larger program, in or on a volume of a storage or distribution 214 | medium, is called an “aggregate” if the compilation and its resulting 215 | copyright are not used to limit the access or legal rights of the compilation's users 216 | beyond what the individual works permit. Inclusion of a covered work in an aggregate 217 | does not cause this License to apply to the other parts of the aggregate. 218 | 219 | ### 6. Conveying Non-Source Forms 220 | 221 | You may convey a covered work in object code form under the terms of sections 4 and 222 | 5, provided that you also convey the machine-readable Corresponding Source under the 223 | terms of this License, in one of these ways: 224 | 225 | * **a)** Convey the object code in, or embodied in, a physical product (including a 226 | physical distribution medium), accompanied by the Corresponding Source fixed on a 227 | durable physical medium customarily used for software interchange. 228 | * **b)** Convey the object code in, or embodied in, a physical product (including a 229 | physical distribution medium), accompanied by a written offer, valid for at least 230 | three years and valid for as long as you offer spare parts or customer support for 231 | that product model, to give anyone who possesses the object code either **(1)** a copy of 232 | the Corresponding Source for all the software in the product that is covered by this 233 | License, on a durable physical medium customarily used for software interchange, for 234 | a price no more than your reasonable cost of physically performing this conveying of 235 | source, or **(2)** access to copy the Corresponding Source from a network server at no 236 | charge. 237 | * **c)** Convey individual copies of the object code with a copy of the written offer to 238 | provide the Corresponding Source. This alternative is allowed only occasionally and 239 | noncommercially, and only if you received the object code with such an offer, in 240 | accord with subsection 6b. 241 | * **d)** Convey the object code by offering access from a designated place (gratis or for 242 | a charge), and offer equivalent access to the Corresponding Source in the same way 243 | through the same place at no further charge. You need not require recipients to copy 244 | the Corresponding Source along with the object code. If the place to copy the object 245 | code is a network server, the Corresponding Source may be on a different server 246 | (operated by you or a third party) that supports equivalent copying facilities, 247 | provided you maintain clear directions next to the object code saying where to find 248 | the Corresponding Source. Regardless of what server hosts the Corresponding Source, 249 | you remain obligated to ensure that it is available for as long as needed to satisfy 250 | these requirements. 251 | * **e)** Convey the object code using peer-to-peer transmission, provided you inform 252 | other peers where the object code and Corresponding Source of the work are being 253 | offered to the general public at no charge under subsection 6d. 254 | 255 | A separable portion of the object code, whose source code is excluded from the 256 | Corresponding Source as a System Library, need not be included in conveying the 257 | object code work. 258 | 259 | A “User Product” is either **(1)** a “consumer product”, which 260 | means any tangible personal property which is normally used for personal, family, or 261 | household purposes, or **(2)** anything designed or sold for incorporation into a 262 | dwelling. In determining whether a product is a consumer product, doubtful cases 263 | shall be resolved in favor of coverage. For a particular product received by a 264 | particular user, “normally used” refers to a typical or common use of 265 | that class of product, regardless of the status of the particular user or of the way 266 | in which the particular user actually uses, or expects or is expected to use, the 267 | product. A product is a consumer product regardless of whether the product has 268 | substantial commercial, industrial or non-consumer uses, unless such uses represent 269 | the only significant mode of use of the product. 270 | 271 | “Installation Information” for a User Product means any methods, 272 | procedures, authorization keys, or other information required to install and execute 273 | modified versions of a covered work in that User Product from a modified version of 274 | its Corresponding Source. The information must suffice to ensure that the continued 275 | functioning of the modified object code is in no case prevented or interfered with 276 | solely because modification has been made. 277 | 278 | If you convey an object code work under this section in, or with, or specifically for 279 | use in, a User Product, and the conveying occurs as part of a transaction in which 280 | the right of possession and use of the User Product is transferred to the recipient 281 | in perpetuity or for a fixed term (regardless of how the transaction is 282 | characterized), the Corresponding Source conveyed under this section must be 283 | accompanied by the Installation Information. But this requirement does not apply if 284 | neither you nor any third party retains the ability to install modified object code 285 | on the User Product (for example, the work has been installed in ROM). 286 | 287 | The requirement to provide Installation Information does not include a requirement to 288 | continue to provide support service, warranty, or updates for a work that has been 289 | modified or installed by the recipient, or for the User Product in which it has been 290 | modified or installed. Access to a network may be denied when the modification itself 291 | materially and adversely affects the operation of the network or violates the rules 292 | and protocols for communication across the network. 293 | 294 | Corresponding Source conveyed, and Installation Information provided, in accord with 295 | this section must be in a format that is publicly documented (and with an 296 | implementation available to the public in source code form), and must require no 297 | special password or key for unpacking, reading or copying. 298 | 299 | ### 7. Additional Terms 300 | 301 | “Additional permissions” are terms that supplement the terms of this 302 | License by making exceptions from one or more of its conditions. Additional 303 | permissions that are applicable to the entire Program shall be treated as though they 304 | were included in this License, to the extent that they are valid under applicable 305 | law. If additional permissions apply only to part of the Program, that part may be 306 | used separately under those permissions, but the entire Program remains governed by 307 | this License without regard to the additional permissions. 308 | 309 | When you convey a copy of a covered work, you may at your option remove any 310 | additional permissions from that copy, or from any part of it. (Additional 311 | permissions may be written to require their own removal in certain cases when you 312 | modify the work.) You may place additional permissions on material, added by you to a 313 | covered work, for which you have or can give appropriate copyright permission. 314 | 315 | Notwithstanding any other provision of this License, for material you add to a 316 | covered work, you may (if authorized by the copyright holders of that material) 317 | supplement the terms of this License with terms: 318 | 319 | * **a)** Disclaiming warranty or limiting liability differently from the terms of 320 | sections 15 and 16 of this License; or 321 | * **b)** Requiring preservation of specified reasonable legal notices or author 322 | attributions in that material or in the Appropriate Legal Notices displayed by works 323 | containing it; or 324 | * **c)** Prohibiting misrepresentation of the origin of that material, or requiring that 325 | modified versions of such material be marked in reasonable ways as different from the 326 | original version; or 327 | * **d)** Limiting the use for publicity purposes of names of licensors or authors of the 328 | material; or 329 | * **e)** Declining to grant rights under trademark law for use of some trade names, 330 | trademarks, or service marks; or 331 | * **f)** Requiring indemnification of licensors and authors of that material by anyone 332 | who conveys the material (or modified versions of it) with contractual assumptions of 333 | liability to the recipient, for any liability that these contractual assumptions 334 | directly impose on those licensors and authors. 335 | 336 | All other non-permissive additional terms are considered “further 337 | restrictions” within the meaning of section 10. If the Program as you received 338 | it, or any part of it, contains a notice stating that it is governed by this License 339 | along with a term that is a further restriction, you may remove that term. If a 340 | license document contains a further restriction but permits relicensing or conveying 341 | under this License, you may add to a covered work material governed by the terms of 342 | that license document, provided that the further restriction does not survive such 343 | relicensing or conveying. 344 | 345 | If you add terms to a covered work in accord with this section, you must place, in 346 | the relevant source files, a statement of the additional terms that apply to those 347 | files, or a notice indicating where to find the applicable terms. 348 | 349 | Additional terms, permissive or non-permissive, may be stated in the form of a 350 | separately written license, or stated as exceptions; the above requirements apply 351 | either way. 352 | 353 | ### 8. Termination 354 | 355 | You may not propagate or modify a covered work except as expressly provided under 356 | this License. Any attempt otherwise to propagate or modify it is void, and will 357 | automatically terminate your rights under this License (including any patent licenses 358 | granted under the third paragraph of section 11). 359 | 360 | However, if you cease all violation of this License, then your license from a 361 | particular copyright holder is reinstated **(a)** provisionally, unless and until the 362 | copyright holder explicitly and finally terminates your license, and **(b)** permanently, 363 | if the copyright holder fails to notify you of the violation by some reasonable means 364 | prior to 60 days after the cessation. 365 | 366 | Moreover, your license from a particular copyright holder is reinstated permanently 367 | if the copyright holder notifies you of the violation by some reasonable means, this 368 | is the first time you have received notice of violation of this License (for any 369 | work) from that copyright holder, and you cure the violation prior to 30 days after 370 | your receipt of the notice. 371 | 372 | Termination of your rights under this section does not terminate the licenses of 373 | parties who have received copies or rights from you under this License. If your 374 | rights have been terminated and not permanently reinstated, you do not qualify to 375 | receive new licenses for the same material under section 10. 376 | 377 | ### 9. Acceptance Not Required for Having Copies 378 | 379 | You are not required to accept this License in order to receive or run a copy of the 380 | Program. Ancillary propagation of a covered work occurring solely as a consequence of 381 | using peer-to-peer transmission to receive a copy likewise does not require 382 | acceptance. However, nothing other than this License grants you permission to 383 | propagate or modify any covered work. These actions infringe copyright if you do not 384 | accept this License. Therefore, by modifying or propagating a covered work, you 385 | indicate your acceptance of this License to do so. 386 | 387 | ### 10. Automatic Licensing of Downstream Recipients 388 | 389 | Each time you convey a covered work, the recipient automatically receives a license 390 | from the original licensors, to run, modify and propagate that work, subject to this 391 | License. You are not responsible for enforcing compliance by third parties with this 392 | License. 393 | 394 | An “entity transaction” is a transaction transferring control of an 395 | organization, or substantially all assets of one, or subdividing an organization, or 396 | merging organizations. If propagation of a covered work results from an entity 397 | transaction, each party to that transaction who receives a copy of the work also 398 | receives whatever licenses to the work the party's predecessor in interest had or 399 | could give under the previous paragraph, plus a right to possession of the 400 | Corresponding Source of the work from the predecessor in interest, if the predecessor 401 | has it or can get it with reasonable efforts. 402 | 403 | You may not impose any further restrictions on the exercise of the rights granted or 404 | affirmed under this License. For example, you may not impose a license fee, royalty, 405 | or other charge for exercise of rights granted under this License, and you may not 406 | initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging 407 | that any patent claim is infringed by making, using, selling, offering for sale, or 408 | importing the Program or any portion of it. 409 | 410 | ### 11. Patents 411 | 412 | A “contributor” is a copyright holder who authorizes use under this 413 | License of the Program or a work on which the Program is based. The work thus 414 | licensed is called the contributor's “contributor version”. 415 | 416 | A contributor's “essential patent claims” are all patent claims owned or 417 | controlled by the contributor, whether already acquired or hereafter acquired, that 418 | would be infringed by some manner, permitted by this License, of making, using, or 419 | selling its contributor version, but do not include claims that would be infringed 420 | only as a consequence of further modification of the contributor version. For 421 | purposes of this definition, “control” includes the right to grant patent 422 | sublicenses in a manner consistent with the requirements of this License. 423 | 424 | Each contributor grants you a non-exclusive, worldwide, royalty-free patent license 425 | under the contributor's essential patent claims, to make, use, sell, offer for sale, 426 | import and otherwise run, modify and propagate the contents of its contributor 427 | version. 428 | 429 | In the following three paragraphs, a “patent license” is any express 430 | agreement or commitment, however denominated, not to enforce a patent (such as an 431 | express permission to practice a patent or covenant not to sue for patent 432 | infringement). To “grant” such a patent license to a party means to make 433 | such an agreement or commitment not to enforce a patent against the party. 434 | 435 | If you convey a covered work, knowingly relying on a patent license, and the 436 | Corresponding Source of the work is not available for anyone to copy, free of charge 437 | and under the terms of this License, through a publicly available network server or 438 | other readily accessible means, then you must either **(1)** cause the Corresponding 439 | Source to be so available, or **(2)** arrange to deprive yourself of the benefit of the 440 | patent license for this particular work, or **(3)** arrange, in a manner consistent with 441 | the requirements of this License, to extend the patent license to downstream 442 | recipients. “Knowingly relying” means you have actual knowledge that, but 443 | for the patent license, your conveying the covered work in a country, or your 444 | recipient's use of the covered work in a country, would infringe one or more 445 | identifiable patents in that country that you have reason to believe are valid. 446 | 447 | If, pursuant to or in connection with a single transaction or arrangement, you 448 | convey, or propagate by procuring conveyance of, a covered work, and grant a patent 449 | license to some of the parties receiving the covered work authorizing them to use, 450 | propagate, modify or convey a specific copy of the covered work, then the patent 451 | license you grant is automatically extended to all recipients of the covered work and 452 | works based on it. 453 | 454 | A patent license is “discriminatory” if it does not include within the 455 | scope of its coverage, prohibits the exercise of, or is conditioned on the 456 | non-exercise of one or more of the rights that are specifically granted under this 457 | License. You may not convey a covered work if you are a party to an arrangement with 458 | a third party that is in the business of distributing software, under which you make 459 | payment to the third party based on the extent of your activity of conveying the 460 | work, and under which the third party grants, to any of the parties who would receive 461 | the covered work from you, a discriminatory patent license **(a)** in connection with 462 | copies of the covered work conveyed by you (or copies made from those copies), or **(b)** 463 | primarily for and in connection with specific products or compilations that contain 464 | the covered work, unless you entered into that arrangement, or that patent license 465 | was granted, prior to 28 March 2007. 466 | 467 | Nothing in this License shall be construed as excluding or limiting any implied 468 | license or other defenses to infringement that may otherwise be available to you 469 | under applicable patent law. 470 | 471 | ### 12. No Surrender of Others' Freedom 472 | 473 | If conditions are imposed on you (whether by court order, agreement or otherwise) 474 | that contradict the conditions of this License, they do not excuse you from the 475 | conditions of this License. If you cannot convey a covered work so as to satisfy 476 | simultaneously your obligations under this License and any other pertinent 477 | obligations, then as a consequence you may not convey it at all. For example, if you 478 | agree to terms that obligate you to collect a royalty for further conveying from 479 | those to whom you convey the Program, the only way you could satisfy both those terms 480 | and this License would be to refrain entirely from conveying the Program. 481 | 482 | ### 13. Use with the GNU Affero General Public License 483 | 484 | Notwithstanding any other provision of this License, you have permission to link or 485 | combine any covered work with a work licensed under version 3 of the GNU Affero 486 | General Public License into a single combined work, and to convey the resulting work. 487 | The terms of this License will continue to apply to the part which is the covered 488 | work, but the special requirements of the GNU Affero General Public License, section 489 | 13, concerning interaction through a network will apply to the combination as such. 490 | 491 | ### 14. Revised Versions of this License 492 | 493 | The Free Software Foundation may publish revised and/or new versions of the GNU 494 | General Public License from time to time. Such new versions will be similar in spirit 495 | to the present version, but may differ in detail to address new problems or concerns. 496 | 497 | Each version is given a distinguishing version number. If the Program specifies that 498 | a certain numbered version of the GNU General Public License “or any later 499 | version” applies to it, you have the option of following the terms and 500 | conditions either of that numbered version or of any later version published by the 501 | Free Software Foundation. If the Program does not specify a version number of the GNU 502 | General Public License, you may choose any version ever published by the Free 503 | Software Foundation. 504 | 505 | If the Program specifies that a proxy can decide which future versions of the GNU 506 | General Public License can be used, that proxy's public statement of acceptance of a 507 | version permanently authorizes you to choose that version for the Program. 508 | 509 | Later license versions may give you additional or different permissions. However, no 510 | additional obligations are imposed on any author or copyright holder as a result of 511 | your choosing to follow a later version. 512 | 513 | ### 15. Disclaimer of Warranty 514 | 515 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 516 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 517 | PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER 518 | EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 519 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE 520 | QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 521 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 522 | 523 | ### 16. Limitation of Liability 524 | 525 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY 526 | COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS 527 | PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, 528 | INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 529 | PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE 530 | OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE 531 | WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 532 | POSSIBILITY OF SUCH DAMAGES. 533 | 534 | ### 17. Interpretation of Sections 15 and 16 535 | 536 | If the disclaimer of warranty and limitation of liability provided above cannot be 537 | given local legal effect according to their terms, reviewing courts shall apply local 538 | law that most closely approximates an absolute waiver of all civil liability in 539 | connection with the Program, unless a warranty or assumption of liability accompanies 540 | a copy of the Program in return for a fee. 541 | 542 | _END OF TERMS AND CONDITIONS_ 543 | 544 | ## How to Apply These Terms to Your New Programs 545 | 546 | If you develop a new program, and you want it to be of the greatest possible use to 547 | the public, the best way to achieve this is to make it free software which everyone 548 | can redistribute and change under these terms. 549 | 550 | To do so, attach the following notices to the program. It is safest to attach them 551 | to the start of each source file to most effectively state the exclusion of warranty; 552 | and each file should have at least the “copyright” line and a pointer to 553 | where the full notice is found. 554 | 555 | 556 | Copyright (C) 2019 Indrajeet Patil 557 | 558 | This program is free software: you can redistribute it and/or modify 559 | it under the terms of the GNU General Public License as published by 560 | the Free Software Foundation, either version 3 of the License, or 561 | (at your option) any later version. 562 | 563 | This program is distributed in the hope that it will be useful, 564 | but WITHOUT ANY WARRANTY; without even the implied warranty of 565 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 566 | GNU General Public License for more details. 567 | 568 | You should have received a copy of the GNU General Public License 569 | along with this program. If not, see . 570 | 571 | Also add information on how to contact you by electronic and paper mail. 572 | 573 | If the program does terminal interaction, make it output a short notice like this 574 | when it starts in an interactive mode: 575 | 576 | broomExtra Copyright (C) 2019 Indrajeet Patil 577 | This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. 578 | This is free software, and you are welcome to redistribute it 579 | under certain conditions; type 'show c' for details. 580 | 581 | The hypothetical commands `show w` and `show c` should show the appropriate parts of 582 | the General Public License. Of course, your program's commands might be different; 583 | for a GUI interface, you would use an “about box”. 584 | 585 | You should also get your employer (if you work as a programmer) or school, if any, to 586 | sign a “copyright disclaimer” for the program, if necessary. For more 587 | information on this, and how to apply and follow the GNU GPL, see 588 | <>. 589 | 590 | The GNU General Public License does not permit incorporating your program into 591 | proprietary programs. If your program is a subroutine library, you may consider it 592 | more useful to permit linking proprietary applications with the library. If this is 593 | what you want to do, use the GNU Lesser General Public License instead of this 594 | License. But first, please read 595 | <>. 596 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------