R/jqr-package.R

In jqr: Client for 'jq', a 'JSON' Processor

#' @title jqr
#' @description An R client for the C library jq
#'
#' @section Low-level:
#' Low level interface, in which you can execute `jq` code just as you
#' would on the command line. Available via \code{\link{jq}}
#'
#' @section High-level DSL:
#' High-level, uses a suite of functions to construct queries. Queries
#' are constucted, then excuted internally with \code{\link{jq}}
#'
#' @section Pipes:
#' The high level DSL supports piping, though you don't have to use
#' pipes.
#'
#' @section NSE and SE:
#' Most DSL functions have NSE (non-standard evaluation) and SE
#' (standard evaluation) versions, which make \code{jqr} easy to use
#' for interactive use as well as programming.
#'
#' @section jq version:
#' We link to \code{jq} through the installed version on your system,
#' so the version can vary. Run \code{jq --version} to get your jq version
#'
#' @section indexing:
#' note that \code{jq} indexing starts at \code{0}, whereas R indexing
#' starts at \code{1}. So when you want the first thing in an array using
#' \code{jq}, for example, you want \code{0}, not \code{1}
#'
#' @section output data format:
#' Note that with both the low level interface and the high level DSL, we
#' print the output to look like a valid JSON object to make it easier to
#' look at. However, it's important to know that the output is really just a
#' simple character string or vector of strings - it's just the print function
#' that pretty prints it and makes it look like a single JSON object. What jq
#' is giving you often is a stream of valid JSON objects, each one of which is
#' valid, but altogether are not valid. However, a trick you can do is to
#' wrap your jq program in brackets like \code{[.[]]} instead of \code{.[]}
#' to give a single JSON object
#'
#' Related to above, you can use the function provided \code{\link{string}}
#' with the high level DSL to get back a character string instead of
#' pretty printed version
#'
#' @importFrom lazyeval all_dots lazy_dots
#' @docType package
#' @aliases jqr-package
#' @name jqr
NULL

#' GitHub Commits Data
#'
#' @docType data
#' @keywords datasets
#' @name commits
#' @format A character string of json github commits data for the jq repo.
NULL