Returns the instrument's study: the problem statement, the objectives
(each with an id such as "O1" and its text), and the sampling plan
(population, method from sframe_sampling_methods(), method_other
describing an "other" method, and planned_n), and the preregistration
fields a plan states beyond its blocks (preregistration, with
exclusion_rules, stopping_rule, primary_outcomes,
secondary_outcomes, multiplicity and contingency, each 1 optional
text). The study is inside the hash, so on a published instrument a change
to any of these is a design amendment, recorded with amend_sframe().
Set it with sframe_instrument(study = ) or by assigning
instrument$study. Each plan block may name the objective it serves in its
objective field. The study is never shown to respondents, since telling
them the aims can bias their answers.
Details
validate_sframe() refuses a malformed study, an objective id used twice
and a plan block naming an objective that does not exist. It notes, without
failing, an objective no research question serves, a research question
that names no objective, and a problem statement over 150 words.
Examples
ins <- sframe_instrument("Study", components = list(sframe_item("q1", "Q?", "text")),
study = list(problem = "Why do students leave the course?",
objectives = list(list(id = "O1", text = "Describe the reasons."))))
sframe_get_study(ins)$objectives