Structure and characteristics

The input data required for the package to work with is a tidy dataset (Wickham 2014), where every observation is a row and every variable is a column. This makes the data easy to manipulate, model and visualize.

Two fake datasets to show the possibilities of the package have been created, and they can be accessed using the data(P.education) and data(P.energy) calls.

There are two portfolios, one in the energy sector (P.energy) and one in the education sector (P.education). The energy one looks like follows:

library(PolicyPortfolios)
data(P.energy)
P.energy

## # A tibble: 12,375 × 6
##    Country  Sector  Year Instrument    Target    covered
##    <fct>    <fct>  <int> <fct>         <fct>       <int>
##  1 Syldavia Energy  2020 Instrument 11 Target 16       0
##  2 Syldavia Energy  2021 Instrument 11 Target 16       0
##  3 Syldavia Energy  2022 Instrument 11 Target 16       0
##  4 Syldavia Energy  2023 Instrument 11 Target 16       0
##  5 Syldavia Energy  2024 Instrument 11 Target 16       0
##  6 Syldavia Energy  2025 Instrument 11 Target 16       0
##  7 Syldavia Energy  2026 Instrument 11 Target 16       0
##  8 Syldavia Energy  2027 Instrument 11 Target 16       0
##  9 Syldavia Energy  2028 Instrument 11 Target 16       0
## 10 Syldavia Energy  2029 Instrument 11 Target 16       0
## # ℹ 12,365 more rows

The object P.energy is a tidy data frame (a tibble) that contains 12,375 rows and 6 variables. 5 of the variables are markers of the case, and only one (“covered”) is in fact actual data. It indicates whether in the corresponding observation (defined by “Country”, “Sector”, “Year”, “Instrument” and “Target”) there is policy intervention (1) or not (0).

In this case, the P.energy dataset contains several countries and traces them over several years:

levels(P.energy$Country)

## [1] "Syldavia"      "Borduria"      "San Theodoros"

unique(P.energy$Year)

##  [1] 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030

The portfolio is in fact the combination of a two-dimensional space composed by policy Targets (“Target”) and the policy Instruments (“Instruments”) than can be used to address such targets.

levels(P.energy$Target)

##  [1] "Target 16" "Target 17" "Target 18" "Target 19" "Target 20" "Target 21"
##  [7] "Target 22" "Target 23" "Target 24" "Target 25" "Target 26" "Target 27"
## [13] "Target 28" "Target 29" "Target 30" "Target 31" "Target 32" "Target 33"
## [19] "Target 34" "Target 35" "Target 36" "Target 37" "Target 38" "Target 39"
## [25] "Target 40"

levels(P.energy$Instrument)

##  [1] "Instrument 11" "Instrument 12" "Instrument 13" "Instrument 14"
##  [5] "Instrument 15" "Instrument 16" "Instrument 17" "Instrument 18"
##  [9] "Instrument 19" "Instrument 20" "Instrument 21" "Instrument 22"
## [13] "Instrument 23" "Instrument 24" "Instrument 25"

The variable “Sector” is only introduced to be able to compare policy sectors. Only policy sectors with the same combinations of Instruments and Targets can be in the same dataset. Otherwise it is understood that the total combination of Targets and Instruments is the one that defines the portfolio. Therefore, is preferable to work with separated portfolios when the space defined by Targets and Instruments is different. For instance, in the portfolio of the education sector, the countries and years are equal as in the energy, but the targets and instruments differ:

data(P.education)
levels(P.education$Target)

##  [1] "Target 1"  "Target 10" "Target 11" "Target 12" "Target 13" "Target 14"
##  [7] "Target 15" "Target 2"  "Target 3"  "Target 4"  "Target 5"  "Target 6" 
## [13] "Target 7"  "Target 8"  "Target 9"

levels(P.education$Instrument)

##  [1] "Instrument 1"  "Instrument 10" "Instrument 2"  "Instrument 3" 
##  [5] "Instrument 4"  "Instrument 5"  "Instrument 6"  "Instrument 7" 
##  [9] "Instrument 8"  "Instrument 9"

Prepare a dataset with a portfolio structure

The function pp_clean() may help in transforming the data from a spreadsheet-like format into a tidy format.

By default, it uses a structure coming from the consensus research project. Guidelines for external experts to collect data on social and environmental policies are available, as well as the coding manual. An example of a speardsheet collecting data for policy portfolios in the Consensus project is the following: .

spreadsheet <- read.table(...)
d <- pp_clean(spreadsheet,
              Sector = "Environmental",
              Year.name = "Year.Adopt",
              coding.category.name = "Coding.category",
              Instrument.name = "Instrument.No.",
              Target.name = "Item.No.")

pp_complete()

pp_clean() easily transforms a wide format coming from a spreadsheet into a tidy object suitable for policy portfolio analysis, doing several checks on the consistency of the original data and helping to spot inconsistencies and to debug problems with the coding process.

The coding process involves looking for instances where there is policy intervention in different scenarios, and therefore in cases (Instruments and Targets) when even not a single case of policy intervention has been observed the data would not include such a space. For instance, we may be interested in recording whether there is policy intervention in, say, providing funds for schools when there is a disabled student in a clasroom. But if we do not observe any single case in the portfolio, the final dataset will not contain this possibility, and therefore we must complete the observed portfolio with the potential full range of Targets and instruments. THis is achieved with the pp_complete() function.

dc <- pp_complete(d,
                  Instrument.set = full.factor.of.potential.instruments,
                  Target.set = full.factor.of.potential.targets)

One the dataset is cleaned and complete we may proceed to its analysis.

Summarize portfolios

The main function that summarizes the characteristics of the portfolio is pp_measures(). It takes a tidy portfolio data frame as input and produces a tidy data frame with entries for all the Countries and Years of the original input plus several measures with their corresponding values.

pp_measures(P.energy)

The argument id allows to explicitly ask for concrete portfolios, defined by the elements of the list that is passed.

pp_measures(P.energy, id = list(Country = "Borduria", Year = 2010:2021))

## # A tibble: 38 × 6
##    Country  Sector  Year Measure         value Measure.label                    
##    <fct>    <fct>  <int> <fct>           <dbl> <fct>                            
##  1 Borduria Energy  2020 Space         375     Portfolio space                  
##  2 Borduria Energy  2020 Size            0.016 Portfolio size                   
##  3 Borduria Energy  2020 n.Instruments   5     Number of instruments covered    
##  4 Borduria Energy  2020 p.Instruments   0.333 Proportion of instruments covered
##  5 Borduria Energy  2020 n.Targets       5     Number of targets covered        
##  6 Borduria Energy  2020 p.Targets       0.2   Proportion of targets covered    
##  7 Borduria Energy  2020 Unique          5     Number of unique instrument conf…
##  8 Borduria Energy  2020 C.eq            0.5   Equality of Instrument configura…
##  9 Borduria Energy  2020 Div.aid         0.925 Diversity (Average Instrument Di…
## 10 Borduria Energy  2020 Div.gs          0.778 Diversity (Gini-Simpson)         
## # ℹ 28 more rows

As a tidy dataset itself, the output of pp_measures() can be easily combined with other functions to produce figures or tables of interest:

pp_measures(P.energy) %>%
  # Use only a single measure of interest
  filter(Measure == "Size") %>%
  # Use only observations with a concrete time period
  filter(Year > 2022) %>%
  # Convert the long format into wide, and therefore "Size" becomes a column
  spread(Measure, value) %>%
  # Pass this object to "ggplot()" and produce a time series of portfolio "Size"
  ggplot(aes(x = Year, y = Size, color = Country)) +
    geom_line()

Temporal evolution of the size of portfolios, by country.

In this sense, the output produced by the functions in the package is directly suitable for being used by ggplot2, based on the grammar of graphics (Wilkinson et al. 2005), which empowers R users by allowing them to flexibly crate graphics (Wickham 2009).

pp_measures(P.energy) %>%
  # Pick the two measures of portfolio diversity
  filter(Measure %in% c("Div.gs", "Div.sh")) %>%
  # Use only the last year observation
  filter(Year == max(Year)) %>%
  # Select only the relevant variables required to produce the output table
  select(Country, Measure.label, value) %>%
  # Transform the long object into wide, so that every Measure is one column
  spread(Measure.label, value) %>%
  # Sort by decreasing Shannon diversity
  arrange(desc(`Diversity (Shannon)`))

## # A tibble: 3 × 3
##   Country       `Diversity (Gini-Simpson)` `Diversity (Shannon)`
##   <fct>                              <dbl>                 <dbl>
## 1 Borduria                           0.910                  3.57
## 2 Syldavia                           0.816                  2.52
## 3 San Theodoros                      0.75                   2

The current list of Measures that pp_measures() produces is the following:

Visual display of portfolios

The function pp_plot() produces a visual representation of the two-dimensional space of policy Targets (horizontal axis) and Instruments (vertical axis) and whether such space is covered by policy intervention or not.

It requires a single policy portfolio, and therefore if the original tidy dataset includes several years or countries, this must be explicitly stated using the argument id:

pp_plot(P.energy, id = list(Country = "Borduria", Year = 2025))

## Warning: The `<scale>` argument of `guides()` cannot be `FALSE`. Use "none" instead as
## of ggplot2 3.3.4.
## ℹ The deprecated feature was likely used in the PolicyPortfolios package.
##   Please report the issue at <https://github.com/xfim/PolicyPortfolios/issues>.
## This warning is displayed once every 8 hours.
## Call `lifecycle::last_lifecycle_warnings()` to see where this warning was
## generated.

Visual representation of the Energy portfolio of Borduria in 2025, using the pp_plot() function and defining a specific country and year in a list in the id argument.

By default pp_plot() produces a caption with the source of the data, a subtitle with the measures of the portfolio and the boxes are side by side, but all these features can be tunned in the arguments. Check the documentation for more details.

Several options can be passed to tune the visual aspect of the portfolio, namely spacing, that includes separation between the boxes, dropping the subtitle with subtitle and changing the default caption with caption.

pp_plot(P.education, 
        id = list(Country = "Borduria", Year = 2030),
        spacing = TRUE,
        subtitle = FALSE, caption = NULL)

Visual representation of the Energy portfolio of Borduria in 2025, using the pp_plot() function and defining a specific country and year in a list in the id argument.

Finally, pp_report() is an encompassing function that generates a report in html with detailed descritive analysis of the portfolios, both considering them individually as well as comparatively (comparing countries or measures).

pp_report(P.energy)

It also contains several arguments that can help in the analysis, but the defaults are expected to be comprehensive and meaningful.