DESCRIPTION

Package: hRvstAPI
Title: This is a wrapper for the Harvest REST API v2.
Version: 0.0.0.9000
Authors@R: 
    person(
      "Eric", "Hunt",
      email = "52219938+eric-hunt@users.noreply.github.com",
      role = c("aut", "cre"),
      comment = c(ORCID = "0000-0002-6891-8294")
    )
Description: The foremost function of this package is to act as a *convenient*
    wrapper around the Harvest REST API v2.
      To that end, the package handles credentials either through the system
    keyring using the `keyring` package (preferred), or through environment
    variables written to a local `.Renviron` file. Credential handling can be
    initiated explicitly, but otherwise happens automatically upon making an
    API request.
      This package tries to make accessing the Harvest API as easy as possible.
    While it does allow some tweaking of the actual HTTP request via function
    arguments, the primary method for accessing API data is to simply select
    which resource to query (e.g. "users" will download all users data). *Note,
    that the default is to only download "active" records.*
      The reason for this mode of access is that a request usually isn't very big
    and the typical user will probably want to manipulate the data in a more 
    sophisticated manner for some downstream visualization or other analysis.
    Building on this premise, the secondary function of this package is to
    manage the long term storage of API data to minimize remote requests. This
    is achieved by storing API data in a local SQLite database, for which this
    package also provides a straightforward way of accessing and updating with
    new data.
      There is a companion Shiny application (hRvst) which utilizes this wrapper
    for Harvest API data access, and perhaps slightly enhances this package.
License: MIT + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.1.9000
Depends: R (>= 4.1)
Imports: 
    assertthat,
    bit64,
    DBI,
    dplyr,
    fs,
    getPass,
    glue,
    httr2,
    lubridate,
    purrr,
    readr,
    rlang,
    RSQLite,
    stringr,
    tibble,
    withr
Collate: 
    'access.R'
    'params.R'
    'creds.R'
    'req.R'
    'store.R'
    'zzz.R'
Suggests: 
    keyring