Refactor README and Vignette(s)

[MattCowgill]

We now have three broad groups of functions:

• Functions (such as read_abs()) to load ABS time series data
• Functions (such as download_abs_data_cube() to load ABS data cubes
• Functions (such as read_api()) to load data from the ABS.Stat API

The README should make it clear what each of these groups of functions are, what they do, and when you would use one over the other. Each group of functions should have a separate vignette OR a clearly-delineated separate section in a single vignette.

• README
• Vignette(s)

[palesl]

functions work but help files are (apparently) corrupted (see below), not sure if me or the documentation. probably me honestly.

`Downloading GitHub repo mattcowgill/readabs@HEAD
── R CMD build ──────────────────────────────────────────────────
✔ checking for file ‘/private/var/folders/fg/5j7kqkrs16n_y_bq3rhkzlqnswp4y_/T/Rtmpp5NBaO/remotes68e43c892ebc/MattCowgill-readabs-82387c2/DESCRIPTION’ ...
─ preparing ‘readabs’:
✔ checking DESCRIPTION meta-information ...
─ checking for LF line-endings in source and make files and shell scripts
─ checking for empty or unneeded directories
─ looking to see if a ‘data/datalist’ file should be added
─ building ‘readabs_0.4.13.901.tar.gz’
Warning: invalid uid value replaced by that for user 'nobody'
Warning: invalid gid value replaced by that for user 'nobody'

Installing package into ‘/Users/u1040068/Library/R/arm64/4.2/library’
(as ‘lib’ is unspecified)

• installing source package ‘readabs’ ...
  ** using staged installation
  ** R
  ** byte-compile and prepare package for lazy loading
  ** help
  *** installing help indices
  *** copying figures
  ** building package indices
  ** installing vignettes
  ** testing if installed package can be loaded from temporary location
  ** testing if installed package can be loaded from final location
  ** testing if installed package keeps a record of temporary installation path
• DONE (readabs)

library(readabs)
Environment variable 'R_READABS_PATH' is unset. Downloaded files will be saved in a temporary directory.
You can set 'R_READABS_PATH' at any time. To set it for the rest of this session, use
Sys.setenv(R_READABS_PATH = )
Error in fetch(key) :
lazy-load database '/Users/u1040068/Library/R/arm64/4.2/library/readabs/help/readabs.rdb' is corrupt`

[MattCowgill]

Very weird @palesl, I’ll check it out

[MattCowgill]

Hi @palesl, I can't reproduce this, which is weird! We're both on arm64 (Apple Silicon) machines, too.

Could you please try restarting R, then doing this again?

remotes::install_github("MattCowgill/readabs") 
library(readabs)

[palesl]

HI Matt, yes it seems to work now, thanks!