R/srvHitsForReceiver.R

In jbrzusto/motusClient: fetch data from the motus data server

#' get the hits for a receiver from the data server
#'
#' @param batchID integer scalar motus batch ID
#' @param hitID double scalar ID of latest hit already obtained.
#' Default: 0, meaning none.
#'
#' @return data.frame with these columns:
#' \itemize{
#'   \item (double) hitID
#'   \item (double) runID
#'   \item (integer) batchID
#'   \item (double) ts
#'   \item (double) sig
#'   \item (double) sigSD
#'   \item (double) noise
#'   \item (double) freq
#'   \item (double) freqSD
#'   \item (double) slop
#'   \item (double) burstSlop
#' }
#'
#' @export
#'
#' @author John Brzustowski \email{jbrzusto@@REMOVE_THIS_PART_fastmail.fm}

srvHitsForReceiver = function(batchID, hitID=0) {
    x = srvQuery(API=Motus$API_HITS_FOR_RECEIVER, params=list(batchID=batchID, hitID=hitID))
    return (structure(x, class = "data.frame", row.names=seq(along=x[[1]])))
}