Skip to content

Commit

Permalink
drop cross-reference for R CMD check
Browse files Browse the repository at this point in the history
  • Loading branch information
fsolt committed Jul 2, 2023
1 parent 6ec4b5f commit af92fc8
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 4 deletions.
2 changes: 0 additions & 2 deletions R/read_ascii.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
#' @param respondent_pattern For use when the file does not contain a line for every card for every respondent (or contains extra lines that correspond to no respondent), a regular expression that matches the file's respondent identifier; e.g., if the respondent number is stored in the first four digits of each line, preceded by a space, "(?<=^\\s)\\d{4}".
#'
#' @details Many older Roper Center datasets are available only in ASCII format, which is notoriously difficult to work with. The `read_ascii` function facilitates the process of extracting selected variables from ASCII datasets. For single-card files, one can simply identify the names, positions, and widths of the needed variables from the codebook and pass them to \code{read_ascii}'s \code{var_names}, \code{var_positions}, and \code{var_widths} arguments. Multicard datasets are more complicated. In the best case, the file contains one line per card per respondent; then, the user can extract the needed variables by adding only the \code{var_cards} and \code{total_cards} arguments. When this condition is violated---there is not a line for every card for every respondent, or there are extra lines---the function will throw an error and request the user specify the additional arguments \code{card_pattern} and \code{respondent_pattern}.
#'
#' See \code{\link[readroper]{read_rpr}} for an alternate implementation.
#'
#' @return A data frame containing any variables specified in the \code{var_names} argument, plus a numeric \code{respondent} identifier and as many string \code{card} variables (\code{card1}, \code{card2}, ...) as specified by the \code{total_cards} argument.
#'
Expand Down
2 changes: 0 additions & 2 deletions man/read_ascii.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit af92fc8

Please sign in to comment.