Skip to content

Commit 66d19ed

Browse files
committed
caveats tools
1 parent 1345c27 commit 66d19ed

File tree

1 file changed

+96
-55
lines changed

1 file changed

+96
-55
lines changed

docs/reproducibility-guidance/open-material.qmd

Lines changed: 96 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -6,107 +6,148 @@ format:
66
html:
77
toc: true
88
toc-expand: 2
9+
editor:
10+
markdown:
11+
wrap: 72
912
---
1013

1114
## Software for official statistics
1215

13-
There are many open-source software packages for official statistics and survey
14-
statistics. The two best lists of these packages are:
16+
There are many open-source software packages for official statistics and
17+
survey statistics. The two best lists of these packages are:
1518

16-
- [Awesome list of official statistics software](https://github.com/SNStatComp/awesome-official-statistics-software)
17-
- [CRAN task view for Official Statistics](https://CRAN.R-project.org/view=OfficialStatistics)
19+
- [Awesome list of official statistics
20+
software](https://github.com/SNStatComp/awesome-official-statistics-software)
21+
- [CRAN task view for Official
22+
Statistics](https://CRAN.R-project.org/view=OfficialStatistics)
1823

1924
Eurostat also has a similar list that's worth exploring:
2025

21-
- [eurostat@github](https://github.com/eurostat/README?tab=readme-ov-file)
26+
- [eurostat\@github](https://github.com/eurostat/README?tab=readme-ov-file)
2227

23-
Although some of the packages on these lists are for computing
24-
index numbers (and are enumerated in the next section), there are several
28+
Although some of the packages on these lists are for computing index
29+
numbers (and are enumerated in the next section), there are several
2530
complementary tools for, e.g., sampling, seasonal adjustment, that are
2631
nonetheless important for price statistics.
2732

28-
The [UNECE High-Level Group for the Modernisation of Official Statistics](https://unece.github.io/OSS/)
29-
gives a good overview of the role of open-source software in the production official statistics, and
33+
The [UNECE High-Level Group for the Modernisation of Official
34+
Statistics](https://unece.github.io/OSS/) gives a good overview of the
35+
role of open-source software in the production official statistics, and
3036
can help contextualize the software on these lists.
3137

3238
## Software for price statistics
3339

34-
::: {.callout-note title = "This list is a work in progress"}
35-
Please let us know about any software packages for making price indexes that
36-
we missed.
37-
:::
38-
39-
Open source software for price statistics can be split into packages for
40+
::: {.callout-note title = "This list is a work in progress"} Please let
41+
us know about any software packages relevant for price statistics that
42+
we missed. :::
43+
44+
Most software for price statistics is implemented in R, with the
45+
remainder in Python. Note that this list is for software *packages*
46+
related to price statistics that are broadly available on, e.g., CRAN or
47+
PyPI, not data analysis *scripts* used to derive a price index. Packages
48+
enable efficient code reuse across multiple projects. The projects
49+
listed here may differ in various aspects, such as maturity level,
50+
maintenance status, licensing terms, and more. Users are encouraged to
51+
assess whether each open-source tool aligns with their specific
52+
requirements.
53+
54+
Open source software for price statistics are split into packages for
4055
computing index numbers and software to facilitate accessible official
41-
statistics. Most software for price statistics is implemented in R, with the
42-
remainder in Python. Note that this list is for software _packages_ related to
43-
price statistics that are broadly available on, e.g., CRAN or PyPI, not data
44-
analysis _scripts_ used to derive a price index.
56+
statistics.
4557

4658
### Computing price indexes
4759

4860
#### Multilaterals and scanner data
4961

50-
- [IndexNumR {{< fa brands r-project >}}](https://cran.r-project.org/package=IndexNumR)
51-
- [PriceIndices {{< fa brands r-project >}}](https://cran.r-project.org/package=PriceIndices)
62+
- [IndexNumR
63+
{{< fa brands r-project >}}](https://cran.r-project.org/package=IndexNumR)
64+
- [PriceIndices
65+
{{< fa brands r-project >}}](https://cran.r-project.org/package=PriceIndices)
5266

5367
#### Aggregation
5468

55-
- [piar {{< fa brands r-project >}}](https://cran.r-project.org/package=piar)
69+
- [piar
70+
{{< fa brands r-project >}}](https://cran.r-project.org/package=piar)
5671

5772
#### Housing
5873

59-
- [hpiR {{< fa brands r-project >}}](https://cran.r-project.org/package=hpiR)
60-
- [rsmatrix {{< fa brands r-project >}}](https://cran.r-project.org/package=rsmatrix)
74+
- [hpiR
75+
{{< fa brands r-project >}}](https://cran.r-project.org/package=hpiR)
76+
- [rsmatrix
77+
{{< fa brands r-project >}}](https://cran.r-project.org/package=rsmatrix)
6178

6279
#### General purpose
6380

64-
- [IndexNumberTools {{< fa brands r-project >}}](https://cran.r-project.org/package=IndexNumberTools)
81+
- [IndexNumberTools
82+
{{< fa brands r-project >}}](https://cran.r-project.org/package=IndexNumberTools)
6583

6684
### Accessing price indexes
6785

68-
- [auxdex {{< fa brands python >}}](https://github.com/rbturnbull/ausdex)
69-
- [cansim {{< fa brands r-project >}}](https://cran.r-project.org/package=cansim)
70-
- [hicp {{< fa brands r-project >}}](https://cran.r-project.org/package=hicp)
71-
- [palewire {{< fa brands python >}}](https://github.com/palewire/cpi)
86+
- [auxdex
87+
{{< fa brands python >}}](https://github.com/rbturnbull/ausdex)
88+
- [cansim
89+
{{< fa brands r-project >}}](https://cran.r-project.org/package=cansim)
90+
- [hicp
91+
{{< fa brands r-project >}}](https://cran.r-project.org/package=hicp)
92+
- [palewire {{< fa brands python >}}](https://github.com/palewire/cpi)
7293

7394
### Software papers
7495

75-
- [dff](https://github.com/eurostat/dff)
76-
- [IndexNumber: An R Package for Measuring the Evolution of Magnitudes](https://doi.org/10.32614/RJ-2021-038)
77-
- [piar: Price Index Aggregation in R](https://doi.org/10.21105/joss.06781)
96+
- [dff](https://github.com/eurostat/dff)
97+
- [IndexNumber: An R Package for Measuring the Evolution of
98+
Magnitudes](https://doi.org/10.32614/RJ-2021-038)
99+
- [piar: Price Index Aggregation in
100+
R](https://doi.org/10.21105/joss.06781)
78101

79102
### Older/inactive projects
80103

81-
- [FEWS {{< fa brands r-project >}}](https://github.com/Donal-lynch/FEWS_package)
82-
- [GEKSdecomp {{< fa brands r-project >}}](https://github.com/MjStansfi/GEKSdecomp)
83-
- [IndexNumber {{< fa brands r-project >}}](https://cran.r-project.org/package=IndexNumber)
84-
- [Inflation {{< fa brands r-project >}}](https://cran.r-project.org/package=Inflation)
85-
- [micEconIndex {{< fa brands r-project >}}](https://cran.r-project.org/package=micEconIndex)
86-
- [multilateral {{< fa brands r-project >}}](https://github.com/StatisticsNZ/multilateral)
87-
- [precon {{< fa brands python >}}](https://github.com/ONSBigData/precon)
88-
- [PriceIndexCalc {{< fa brands python >}}](https://github.com/drrobotk/PriceIndexCalc)
89-
- [productivity {{< fa brands r-project >}}](https://cran.r-project.org/package=productivity)
90-
- [TPDdecomp {{< fa brands r-project >}}](https://github.com/MjStansfi/TPDdecomp)
104+
- [FEWS
105+
{{< fa brands r-project >}}](https://github.com/Donal-lynch/FEWS_package)
106+
- [GEKSdecomp
107+
{{< fa brands r-project >}}](https://github.com/MjStansfi/GEKSdecomp)
108+
- [IndexNumber
109+
{{< fa brands r-project >}}](https://cran.r-project.org/package=IndexNumber)
110+
- [Inflation
111+
{{< fa brands r-project >}}](https://cran.r-project.org/package=Inflation)
112+
- [micEconIndex
113+
{{< fa brands r-project >}}](https://cran.r-project.org/package=micEconIndex)
114+
- [multilateral
115+
{{< fa brands r-project >}}](https://github.com/StatisticsNZ/multilateral)
116+
- [precon
117+
{{< fa brands python >}}](https://github.com/ONSBigData/precon)
118+
- [PriceIndexCalc
119+
{{< fa brands python >}}](https://github.com/drrobotk/PriceIndexCalc)
120+
- [productivity
121+
{{< fa brands r-project >}}](https://cran.r-project.org/package=productivity)
122+
- [TPDdecomp
123+
{{< fa brands r-project >}}](https://github.com/MjStansfi/TPDdecomp)
91124

92125
## Reproducibility resources
93126

94-
There are several good resources for how to make data analysis and research
95-
projects reproducible. These are not about price statistics _per se_, but the
96-
ideas and tools are broadly applicable to the field. The [example of a price-index pipeline](https://github.com/UN-Task-Team-for-Scanner-Data/price-index-pipeline)
97-
shows how these ideas around reproducibility can pair with the software listed
98-
above.
127+
There are several good resources for how to make data analysis and
128+
research projects reproducible. These are not about price statistics
129+
*per se*, but the ideas and tools are broadly applicable to the field.
130+
The [example of a price-index
131+
pipeline](https://github.com/UN-Task-Team-for-Scanner-Data/price-index-pipeline)
132+
shows how these ideas around reproducibility can pair with the software
133+
listed above.
99134

100135
### General
101136

102-
- [The Turing Way](https://book.the-turing-way.org/)
103-
- [Awesome Reproducible Research](https://github.com/leipzig/awesome-reproducible-research)
137+
- [The Turing Way](https://book.the-turing-way.org/)
138+
- [Awesome Reproducible
139+
Research](https://github.com/leipzig/awesome-reproducible-research)
104140

105141
### Reproducible analytical pipelines
106142

107-
- [RAP Companion](https://ukgovdatascience.github.io/rap_companion/)
108-
- [Udemy course on RAP with R](https://www.udemy.com/course/reproducible-analytical-pipelines/)
109-
- [Reproducible Analytical Pipelines or RAP (NHS) site](https://nhsdigital.github.io/rap-community-of-practice/introduction_to_RAP/what_is_RAP/)
110-
- [ESCAP training on RAP with web scraping application for price statistics](https://escap-sd.github.io/ESCAP_RAP_class/docs/)
111-
- [Building reproducible analytical pipelines with R](https://raps-with-r.dev/)
112-
- [Projects with targets](https://books.ropensci.org/targets/projects.html)
143+
- [RAP Companion](https://ukgovdatascience.github.io/rap_companion/)
144+
- [Udemy course on RAP with
145+
R](https://www.udemy.com/course/reproducible-analytical-pipelines/)
146+
- [Reproducible Analytical Pipelines or RAP (NHS)
147+
site](https://nhsdigital.github.io/rap-community-of-practice/introduction_to_RAP/what_is_RAP/)
148+
- [ESCAP training on RAP with web scraping application for price
149+
statistics](https://escap-sd.github.io/ESCAP_RAP_class/docs/)
150+
- [Building reproducible analytical pipelines with
151+
R](https://raps-with-r.dev/)
152+
- [Projects with
153+
targets](https://books.ropensci.org/targets/projects.html)

0 commit comments

Comments
 (0)