Skip to content

statisticsnorway/ssb-pre-system

Repository files navigation

SSB pre-system

Forsystem for månedlige og kvartalsvise NR-statistikker

PyPI Status Python Version License

Documentation Tests Coverage Quality Gate Status

pre-commit Black Ruff Poetry

Features

Prosjektet består av to klasser (Formula og PreSystem) og to funksjoner (convert og convert_step).

Formula

Indicator-underklassen definerer et indikatorobjekt som favner om de fleste indikatorer i nasjonalregnskapet,

$$ x_t = x_T\cdot\frac{k_t\sum_i w_{i,T} I_{i,t}}{\sum_{s\in T}k_s\sum_i w_{i,T} I_{i,s}}, $$

der $x$ er den aktuelle nasjonalregnskapsvariabelen, $w$ er vekter, $I$ er indikatorer. $T$ betegner basisåret. $k$ er en korreksjon som er lik én med mindre brukeren ønsker å foreta en korreksjon.

FDeflate-underklassen tar utgangspunkt i en eksisterende formel (for eksempel en Indicator-instans) og deflaterer denne,

$$ \sum_{s\in T}x_s\cdot\frac{k_t x_t/\sum_i w_{i,T} I_{i,t}}{\sum_{s\in T}k_s x_s/\sum_i w_{i,T} I_{i,s}}. $$

FInflate-underklassen tar utgangspunkt i en eksisterende formel (for eksempel en Indicator-instans) og inflaterer denne,

$$ \sum_{s\in T}x_s\cdot\frac{k_t x_t\sum_i w_{i,T} I_{i,t}}{\sum_{s\in T}k_s x_s\sum_i w_{i,T} I_{i,s}}. $$

FSum summerer andre Formula-insanser, FSumProd lager et summerprodukt, FMutlt multipliserer to instanser, og FDiv dividerer.

Alle undeklassene har metodene what og evaluate. formel.what vil returnere en tekstlig representasjon av definisjonen på formelen. Dette lar brukeren spore seg tilbake til én eller flere Indicator-instanser (alle formler må til slutt ende i Indicator-instanser). formel.evaluate(års_df, indikator_df, vekt_df, korreksjon_df) returnerer en Pandas-serie som er den aktuelle formelen evaluert gjenstand for data.

PreSystem

Klassen PreSystem lar brukeren initialisere et forsystem-objekt. Dette har som oppgave å holde instanser av Formel-objekter og la brukeren enkelt evaluere alle formler som er en del av forsystemet.

Convert og convert_step

Dette er funksjoner som lar brukeren konvertere en Pandas DataFrame fra én frekvens til en annen.

Installation

You can install SSB pre-system via pip from PyPI:

pip install ssb-pre-system

Usage

Please see the Reference Guide for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, SSB pre-system is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from Statistics Norway's SSB PyPI Template.

About

Forsystem for månedlige og kvartalsevise NR-statistikker

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages