#'

#' @param file_name The name of the relative or full file to be uploaded into

#' the REDCap project.  Required.

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param record The record ID where the file is to be imported.  Required

#'

#' @description This function uses REDCap's API to query its version.

#'

#' @param token The user-specific string that serves as the password for

#' a project.  Required.

#' @param verbose A boolean value indicating if `message`s should be printed

      #   under the control of the caller.

    )

}

# This function isn't used during testing itself.  Just to create the expected file.

  # nocov start

  path <- file.path("inst", path)

  if (!dir.exists(dirname(path))) dir.create(dirname(path), recursive = FALSE)

  # nocov end

}

    stop("The expected file `", full_path, "` was not found.")  # nocov

    )

    )

#' (Copied from "Export Instrument-Event Mappings" method of

#' REDCap API documentation, v.10.5.1)

#'

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param arms A character string of arms to retrieve.  (Default: '1')

  )

      #    it's under the control of the caller.

    )

    }

  }

#' @param continue_on_error If an error occurs while reading, should records

#' in subsequent batches be attempted.  The default is `FALSE`, which prevents

#' subsequent batches from running.  Required.

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param records An array, where each element corresponds to the ID of a

#' \dontrun{

#' uri     <- "https://bbmc.ouhsc.edu/redcap/api/"

#' token   <- "9A81268476645C4E5F03428B8AC3AA7B"

#' REDCapR::redcap_read(batch_size=2, redcap_uri=uri, token=token)$data

#'

#' col_types <- readr::cols(

#'   record_id  = readr::col_integer(),

#'   race___1   = readr::col_logical(),

  # Continue as intended if the initial query succeeded. --------------------

    warn_hash_record_id()  # nocov

#' directory. Optional

#' @param overwrite Boolean value indicating if existing files should be

#' overwritten. Optional

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param record The record ID where the file is to be imported. Required

      # process the content-type to get the file name

      )

    }

    } else {

#' @description This function is used by other functions to read and write

#' values.

#'

#' @param post_body List of contents expected by the REDCap API.  Required.

#' @param config_options  A list of options to pass to `POST` method in the

#' `httr` package.  See the details below.  Optional.

  # Overwrite the success flag if the raw_text is bad.

  if (

  ) {

    success     <- FALSE  # nocov

#' @description This function reads all available data access groups from

#'   REDCap an returns them as a [base::data.frame()].

#'

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param http_response_encoding  The encoding value passed to

    )

#'

#' @param ds The [base::data.frame()] to be imported into the REDCap project.

#' Required.

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param overwrite_with_blanks A boolean value indicating if

  config_options  = NULL

) {

#'

#' @description This function uses REDCap's API to download a file.

#'

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param record The record ID where the file is to be imported. Required

#' @description This function uses REDCap's API to select and return data.

#' This function is still in development.

#'

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param records An array, where each element corresponds to the ID of a

      {

#' (Copied from "Export Instruments (Data Entry Forms)" method of

#' REDCap API documentation, v.10.5.1)

#'

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param verbose A boolean value indicating if `message`s should be printed

      #    it's under the control of the caller.

    )

    }

  }

#' as a [base::data.frame()]. Each row in the data dictionary corresponds to

#' one field in the project's dataset.

#'

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param forms An array, where each element corresponds to the REDCap form

    )

}

# Privately-scoped function

  redcap_uri,

  token,

  username,

) {

  # Progress through the optional checks

    )

    )

#' @export

    )

    )

#' @export

constant_to_form_completion <- function(x) {

#' @export

constant_to_form_rights <- function(x) {

#' @export

constant_to_export_rights <- function(x) {

#' @export

constant_to_access <- function(x) {

  add_unknown_level = FALSE

) {

  }

collapse_vector <- function(elements, collapsed) {

    # This is an empty string if `elements` (eg, fields`) is NULL.

}

## We're intentionally not exporting this function.

}

#'

#' @param ds The [base::data.frame()] to be imported into the REDCap project.

#' Required.

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param verbose A boolean value indicating if `message`s should be printed

  verbose         = TRUE,

  config_options  = NULL

) {

#' @description Exports the data set of a report created on a project's

#' 'Data Exports, Reports, and Stats' page.

#'

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param report_id A single integer, provided next to the report name on the

    )

#' @description This function reads the available logging messages from

#'   REDCap an returns them as a [base::data.frame()].

#'

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param log_begin_date Return the events occurring after midnight of this

#' @param continue_on_error If an error occurs while writing, should records

#' in subsequent batches be attempted.  The default is `FALSE`, which prevents

#' subsequent batches from running.  Required.

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param overwrite_with_blanks A boolean value indicating if

#'

#' @description List users authorized for a project.

#'

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param verbose A boolean value indicating if `message`s should be printed

      #   under the control of the caller.

    )

#'

#' @description Export Arms of a REDCap project

#'

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#'

#'

#' @description Determines the next available record ID.

#'

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param verbose A boolean value indicating if `message`s should be printed

#' @description This function calls the 'exportFieldNames' function of the

#' REDCap API.

#'

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param verbose A boolean value indicating if `message`s should be printed

      #    it's under the control of the caller.

    )

    }

  }

#'

#' @description This function uses REDCap's API to select and return data.

#'

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param records An array, where each element corresponds to the ID of a

    )

#' directory. Optional.

#' @param overwrite Boolean value indicating if existing files should be

#' overwritten. Optional.

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param record The record ID of the instrument(s).  If empty, the responses

    }

    } else {

#'

#' @description Delete existing records by their ID from REDCap.

#'

#' @param token The user-specific string that serves as the password for a

#' project.  Required.

#' @param records_to_delete A character vector of the project's `record_id`

  }