diff --git a/README.Rmd b/README.Rmd index bff2784..1536f52 100644 --- a/README.Rmd +++ b/README.Rmd @@ -18,8 +18,7 @@ This package is in early *BETA* and new changes will most likely not have backwa ### A short message in Danish Denne R Statistics pakke indeholder funktioner til at give dig adgang til data gennem API'en fra Danmarks Statistik. -Funktionerne henter data fra Statistikbanken og retunerer data.frame objekter med værdierne du spørger efter i -dit funktionskald. +Funktionerne henter data fra Statistikbanken og retunerer data.frame objekter med værdierne du spørger efter i dit funktionskald. ## Installation @@ -54,12 +53,11 @@ install.packages( ) ``` -You can install the latest development version of `{dkstat}` from [GitHub](https://github.com/aleksanderbl29/dkstat) with: +You can install the latest development version of `{dkstat}` from [GitHub](https://github.com/rOpenGov/dkstat) with: ``` r # install.packages("devtools") -devtools::install_github("aleksanderbl29/dkstat") -``` +devtools::install_github("rOpenGov/dkstat") ``` ## Examples diff --git a/README.md b/README.md index 27abc21..a6cc38e 100644 --- a/README.md +++ b/README.md @@ -40,37 +40,39 @@ install.packages( ``` You can install the latest development version of `{dkstat}` from -[GitHub](https://github.com/aleksanderbl29/dkstat) with: +[GitHub](https://github.com/rOpenGov/dkstat) with: ``` r # install.packages("devtools") -devtools::install_github("aleksanderbl29/dkstat") +devtools::install_github("rOpenGov/dkstat") ``` +## Examples - ## Examples +The default language is danish, but have got a lang parameter that you +can change from “da” to “en” if you wan’t the data returned in English. - The default language is danish, but have got a lang parameter that you can change - from "da" to "en" if you wan't the data returned in English. +### Four basic function - ### Four basic function +There are four basic functions to learn: - There are four basic functions to learn: +- dst_search() This function makes it possible to search through the + different tables for a word or a phrase. +- dst_tables() This function downloads all the possible tables + available. +- dst_meta() This function lets you download the meta data for a + specific table, so you can see the description, unit, variables and + values you can download data for. +- dst_get_data() lets you download the actual data you wan’t. - - dst_search() This function makes it possible to search through the different tables for a word or a phrase. - - dst_tables() This function downloads all the possible tables available. - - dst_meta() This function lets you download the meta data for a specific table, so you can see the description, - unit, variables and values you can download data for. - - dst_get_data() lets you download the actual data you wan't. +Here are a few simple examples that will go through the basics of +requesting data from the StatBank and the structure of the output. - Here are a few simple examples that will go through the basics of requesting data from the StatBank - and the structure of the output. +First, we’ll load the package: - First, we'll load the package: - - - ``` r - library(dkstat) +``` r +library(dkstat) +``` ## The search function