Skip to content

Commit

Permalink
Updated the package DESCRIPTION and README
Browse files Browse the repository at this point in the history
  • Loading branch information
byrongibby committed Jan 10, 2025
1 parent 407a7d0 commit 571c2bc
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: econdatar
Title: Automation of Data Tasks to and from Codera Analytics' Econometric Data Services
Version: 3.2.0
Date: 2024-08-19
Version: 3.3.0
Date: 2025-01-10
Authors@R: c(person(given = "Byron", family = "Botha", role = c("aut", "cre"), email = "[email protected]"),
person(given = "Aidan", family = "Horn", role = "ctb"),
person(given = "Sebastian", family = "Krantz", role = "ctb"))
Expand Down
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
```r
install.packages(c("remotes", "tcltk"), repos = "https://cran.mirror.ac.za")
library("remotes")
install_github("coderaanalytics/econdatar", ref = "3.2.0")
install_github("coderaanalytics/econdatar", ref = "3.3.0")
```

Install from disk
Expand All @@ -30,9 +30,17 @@ Or if selecting a particular release **(recommended)**, [see](https://github.com
```r
library("remotes")
remove.packages("econdatar")
install_github("coderaanalytics/econdatar", ref = "3.2.0")
install_github("coderaanalytics/econdatar", ref = "3.3.0")
```

## Connecting to econdata.co.za

In most cases reading and writing data from econdata.co.za requires you to authenticate yourself. This usually requires you to enter an API token which you can get from the web application. Log in to the web application and go to the *Account* page, click on *Show key* and copy the API token by clicking anywhere on the token itself. Paste this token into the dialogue box that appears when running `read_dataset` for example and click *Submit*.

If you are using a service account you can set the `ECONDATA_CREDENTIALS` env variable with the format `client_id;client_secret` in order to automate the above process.

If you are connecting to econdata.co.za through a portal other that the main site (someportal.econdata.co.za rather than www.econdata.co.za) you will need to set the `ECONDATA_URL` and `ECONDATA_AUTH_URL` env variables, please contact [email protected] for further details.

Please see the [EconData blog](https://econdata.co.za) for in depth tutorials

## License
Expand Down

0 comments on commit 571c2bc

Please sign in to comment.