build_subset_surveys: Build photo-roster subset surveys (e.g., for RICH-PGG games.)

build_subset_surveysR Documentation

Build photo-roster subset surveys (e.g., for RICH-PGG games.)

Description

This is a wraper function to create suveys (PDFs) to collect data for RICH-PGG contributions and similar games.

Usage

build_subset_surveys(
  path,
  pid = NULL,
  id_set = NULL,
  game_name = "Choice",
  entry_type = "random",
  set_size = 4,
  pattern = ".jpg",
  token_color = "navyblue",
  max_iter = 10000,
  full_alter_set = TRUE,
  height = 8.5,
  width = 11,
  seed = NA,
  gid_size = 4,
  RID = "CR",
  day = 1,
  month = 3,
  year = 2023
)

Arguments

path

Path to RICH folder.

pid

ID code of focal recipient.

id_set

IDs of alter recipients (as vector).

game_name

Used to label PDF surveys.

entry_type

Pull from all files in SubsetData folder using: "random", "choice", or "predefined". If entry_type is "random", all alters will be selected randomly, in such a way as to fairly balance the number of games in which each alter appears. If entry_type is "choice", then alters will be defined as in the partner-choice game data. If entry_type is "predefined", then a specific "pid" and "id_set" can be added to the inputs in order to build a single PDF file with a specific predefined set of alters file. This can be used, for example, if the researcher wants to manipulate the roster to feature alters with specific characteristics.

set_size

Size of set of possible alters.

pattern

Should "JPG" be "jpg" file endings be used to load photos?

token_color

Number or "color" of tokens placed. If data was entered manually, place whatever value was stored to indiciate a tie: "1"

max_iter

Max time to search for full-scope legal permutations. In random mode, we seek to ensure that each alter appears in exactly the same number of games. Thus, we iterate randomizations until we find such a set.

full_alter_set

Include all alters on roster, or only those who played first round of game?

height

Size of PDF output.

width

Size of PDF output.

seed

Number to use in seeding the randomization process if used.

gid_size

Number of characters in hashcodes for the game IDs.

RID

ID of researcher.

day

Day of interview.

month

Month of interview.

year

Year of interview.

Value

A file folder, SubsetSurveys, filled with PDFs of sub-surveys to run, and a second folder, SubsetContributions, filled with CSV files that will be used to record survey results.

Examples

## Not run: 
build_subset_surveys(path, pattern = ".jpg", token_color="navyblue", full_alter_set = TRUE,
                      entry_type="random", max_iter=10000, set_size=4, 
                      height=8.5, width=11, seed=123, gid_size=4)

## End(Not run)


ctross/DieTryin documentation built on Sept. 8, 2024, 8:07 p.m.