# COINr 
[](https://cran.r-project.org/package=COINr)
[](https://CRAN.R-project.org/package=COINr)
[](https://joss.theoj.org/papers/187b1759658c96177f8d17f3b55b90a0)
[](https://github.com/bluefoxr/COINr/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/bluefoxr/COINr?branch=master)
**Full documentation is available at [COINrs
website](https://bluefoxr.github.io/COINr/)**
COINr is a high-level R package which is the first fully-flexible
development and analysis environment for composite indicators and
scoreboards. The main features can be summarised as features for
*building*, features for *analysis* and features for *visualisation and
presentation*.
**Building features**:
- Flexible and fast development of composite indicators with no limits
on aggregation levels, numbers of indicators, highly flexible set of
methodological choices.
- Denomination by other indicators
- Screening units by data requirements
- Imputation of missing data, by a variety of methods
- Data treatment using Winsorisation and nonlinear transformations
- Normalisation (scaling) using a variety of methods
- Weighting using either manual weighting, PCA weights or
correlation-optimised weights.
- Aggregation of indicators using a variety of methods which can be
different for each aggregation level.
**Analysis features:**
- Detailed indicator statistics, and data availability within
aggregation groups
- Multivariate analysis, including quick functions for PCA, and a
detailed correlation analysis and visualisation
- Easy what if analysis - very quickly checking the effects of
adding and removing indicators, changing weights, methodological
variations
- Full global uncertainty and sensitivity analysis which can check the
impacts of uncertainties in weighting and many methodological
choices
**Visualisation and presentation:**
- Statistical plots of indicators - histograms, violin plots, dot
plots, scatter plots and more
- Bar charts, stacked bar charts and tables for presenting indicator
data and making comparisons between units
- Correlation plots for visualising correlations between indicators
and between aggregation levels
COINr also allows fast import from the [COIN
Tool](https://knowledge4policy.ec.europa.eu/composite-indicators/coin-tool_en)
and fast export to Excel.
## Installation
COINr is on CRAN and can be installed by running:
``` r
# Install released version from CRAN
install.packages("COINr")
```
The development version, which may be slightly more up-to-date, can be
installed from GitHub:
``` r
# Install development version from GitHub
devtools::install_github("bluefoxr/COINr")
```
This should directly install the package from Github, without any other
steps. You may be asked to update packages. This might not be strictly
necessary, so you can also try skipping this step.
## Getting started
COINr needs a little reading and learning to understand properly. But
once you have done that, it can be very powerful for developing
composite indicators.
A good place to get started is COINrs Overview vignette. Try
`vignette("overview")`.
The most thorough documentation is available at [COINrs
website](https://bluefoxr.github.io/COINr/) (developed using pkgdown).
This contains all package documentation in an easy-to-navigate format.
All documentation available here is also available by browsing COINr
vignettes: see `vignette(package = "COINr")`.
## Recent updates
COINr has been recently updated to v1.0, skipping a few version numbers.
This has brought in many new features, some discarded features, less
dependencies and more robust underlying code. The syntax has also been
changed to make the package more consistent. See `vignette("v1")` to
learn about these changes if you were using COINr prior to v1.0.
COINr documentation was previously contained in an [online
book](https://bluefoxr.github.io/COINrDoc/). This is still available,
and although the principles of composite indicators there are still all
valid, the code refers strictly to COINr \< v.1.0.
If you prefer to roll back to the old COINr, you can still install it as
a separate package called COINr6. This is available on GitHub:
``` r
remotes::install_github("bluefoxr/COINr6")
```
# Help and issues
For general help with COINr, the best place to look is the packages
documentation which is available either via the command line
(`vignette(package = "COINr")`) or by checking individual function
documentation (`?function_name`). All documentation is also conveniently
available online at [COINrs
website](https://bluefoxr.github.io/COINr/).
If you find any problems with the package, including bugs or
suggestions, either open a GitHub issue here, or else contact me by
email.
Finally, contributions to the package are most welcome. This should be
done by cloning the repo, making your modifications, and then opening a
pull request. You could also contact me in advance to discuss changes
and extensions. Any changes (especially new functions) should be
accompanied by unit tests, and all existing tests should run without
errors or warnings. To do this, run:
``` r
devtools::test()
```
# Citing COINr
If you have found COINr helpful, we are grateful if you cite the
package. COINr is citable by a paper in the Journal of Open Source
Software which you can find [here](https://doi.org/10.21105/joss.04567)
(with citation information).
In R you can also generate the citation info using
`citation(package = "COINr")`.