Prepare for release (#168)

Relates to #167

Author: maurolepore

.Rbuildignore

@@ -1,17 +1,17 @@
-^r2dii\.data\.Rproj$
-^\.Rproj\.user$
+^CRAN-RELEASE$
 ^LICENSE\.md$
 ^README\.Rmd$
+^\.Rproj\.user$
 ^\.github$
-^codecov\.yml$
 ^_pkgdown\.yml$
-^docs$
-^pkgdown$
-^data-raw$
+^codecov\.yml$
 ^cran-comments\.md$
+^data-raw$
+^docs$
 ^man-roxygen$
-^CRAN-RELEASE$
-^vignettes/articles$
-^vignettes/r2dii-data-0-0-3\.Rmd$
+^pkgdown$
 ^r2dii.data.*.tar.gz$
+^r2dii\.data\.Rproj$
 ^revdep$
+^vignettes/articles$
+^vignettes/r2dii-data-0-0-3\.Rmd$

LICENSE

@@ -1,7 +1,8 @@
 # r2dii.data (development version)
 
-* The definition of `borderline` is now clearer (@georgeharris2deg #163).
+* Change license to CC0; it's the most appropriate for sharing data (#161).
 * New dataset `gics_classification` (@georgeharris2deg #162).
+* The definition of `borderline` is now clearer (@georgeharris2deg #163).
 
 # r2dii.data 0.1.3
 

NEWS.md

@@ -1,7 +1,7 @@
 #' Dataset to bridge (translate) common sector-classification codes
 #'
 #' @description
-#' These dataset serve as a translation key between common sector-classification
+#' This dataset serves as a translation key between common sector-classification
 #' systems and sectors relevant to the 'PACTA' tool
 #' (<https://2degrees-investing.org/resource/pacta/>).
 #'

R/classification_bridge.R

@@ -1,58 +1,38 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
-
-# r2dii.data <a href='https://github.com/2DegreesInvesting/r2dii.data'><img src='https://imgur.com/A5ASZPE.png' align='right' height='43' /></a>
+r2dii.data <a href='https://github.com/2DegreesInvesting/r2dii.data'><img src='https://imgur.com/A5ASZPE.png' align='right' height='43' /></a>
+==============================================================================================================================================
 
 <!-- badges: start -->
+[![Lifecycle: maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing) [![CRAN status](https://www.r-pkg.org/badges/version/r2dii.data)](https://CRAN.R-project.org/package=r2dii.data) [![](https://cranlogs.r-pkg.org/badges/grand-total/r2dii.data)](https://CRAN.R-project.org/package=r2dii.data) [![R build status](https://github.com/2DegreesInvesting/r2dii.data/workflows/R-CMD-check/badge.svg)](https://github.com/2DegreesInvesting/r2dii.data/actions) [![Codecov test coverage](https://codecov.io/gh/2DegreesInvesting/r2dii.data/branch/master/graph/badge.svg)](https://codecov.io/gh/2DegreesInvesting/r2dii.data?branch=master) <!-- badges: end -->
+
+These datasets support the implementation in R of the software PACTA (Paris Agreement Capital Transition Assessment), which is a free tool that calculates the alignment between financial assets and climate scenarios (<https://2degrees-investing.org/>). Financial institutions use PACTA to study how their capital allocation impacts the climate. Because both financial institutions and market data providers keep their data private, this package provides fake, public data to enable the development and use of PACTA in R.
 
-[![Lifecycle:
-maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
-[![CRAN
-status](https://www.r-pkg.org/badges/version/r2dii.data)](https://CRAN.R-project.org/package=r2dii.data)
-[![](https://cranlogs.r-pkg.org/badges/grand-total/r2dii.data)](https://CRAN.R-project.org/package=r2dii.data)
-[![R build
-status](https://github.com/2DegreesInvesting/r2dii.data/workflows/R-CMD-check/badge.svg)](https://github.com/2DegreesInvesting/r2dii.data/actions)
-[![Codecov test
-coverage](https://codecov.io/gh/2DegreesInvesting/r2dii.data/branch/master/graph/badge.svg)](https://codecov.io/gh/2DegreesInvesting/r2dii.data?branch=master)
-<!-- badges: end -->
-
-These datasets support the implementation in R of the software PACTA
-(Paris Agreement Capital Transition Assessment), which is a free tool
-that calculates the alignment between financial assets and climate
-scenarios (<https://2degrees-investing.org/>). Financial institutions
-use PACTA to study how their capital allocation impacts the climate.
-Because both financial institutions and market data providers keep their
-data private, this package provides fake, public data to enable the
-development and use of PACTA in R.
-
-## Installation
+Installation
+------------
 
 Before you install r2dii.analysis you may want to:
 
-  - [Try an rstudio.cloud project with this package already
-    installed](https://rstudio.cloud/project/1424833).
-  - [Learn how to minimize installation
-    errors](https://gist.github.com/maurolepore/a0187be9d40aee95a43f20a85f4caed6#installation).
+-   [Try an rstudio.cloud project with this package already installed](https://rstudio.cloud/project/1424833).
+-   [Learn how to minimize installation errors](https://gist.github.com/maurolepore/a0187be9d40aee95a43f20a85f4caed6#installation).
 
-When you are ready, install the released version of r2dii.data from CRAN
-with:
+When you are ready, install the released version of r2dii.data from CRAN with:
 
 ``` r
 install.packages("r2dii.data")
 ```
 
-Or install the development version of r2dii.data with something like
-this:
+Or install the development version of r2dii.data with something like this:
 
 ``` r
 # install.packages("devtools")
 devtools::install_github("2DegreesInvesting/r2dii.data")
 ```
 
-[How to raise an
-issue?](https://2degreesinvesting.github.io/posts/2020-06-26-instructions-to-raise-an-issue/)
+[How to raise an issue?](https://2degreesinvesting.github.io/posts/2020-06-26-instructions-to-raise-an-issue/)
 
-## Example
+Example
+-------
 
 ``` r
 library(r2dii.data)
@@ -74,15 +54,7 @@ head(data_dictionary)
 #> 6      Flag if company is the ultimate parent in our database
 ```
 
-## Funding
-
-This project has received funding from the [European Union LIFE
-program](https://ec.europa.eu/easme/en/life) and the [International
-Climate Initiative
-(IKI)](https://www.international-climate-initiative.com/en/details/project/measuring-paris-agreement-alignment-and-financial-risk-in-financial-markets-18_I_351-2982).
-The Federal Ministry for the Environment, Nature Conservation and
-Nuclear Safety (BMU) supports this initiative on the basis of a decision
-adopted by the German Bundestag. The views expressed are the sole
-responsibility of the authors and do not necessarily reflect the views
-of the funders. The funders are not responsible for any use that may be
-made of the information it contains.
+Funding
+-------
+
+This project has received funding from the [European Union LIFE program](https://ec.europa.eu/easme/en/life) and the [International Climate Initiative (IKI)](https://www.international-climate-initiative.com/en/details/project/measuring-paris-agreement-alignment-and-financial-risk-in-financial-markets-18_I_351-2982). The Federal Ministry for the Environment, Nature Conservation and Nuclear Safety (BMU) supports this initiative on the basis of a decision adopted by the German Bundestag. The views expressed are the sole responsibility of the authors and do not necessarily reflect the views of the funders. The funders are not responsible for any use that may be made of the information it contains.