Skip to contents

In 0.4.3 every exported function took the sframe_ prefix or a stage verb, so a name says which stage it belongs to and no 2 names sit 1 letter apart. The old names still work and give the same result, with no warning. Set options(surveyframe.warn_superseded = TRUE) to get 1 warning per old name per session, naming its replacement.

Usage

sf_instrument(...)

sf_item(...)

sf_choices(...)

sf_scale(...)

sf_branch(...)

sf_check(...)

sf_conjoint_design(...)

sf_construct(...)

sf_path(...)

sf_covariance(...)

sf_indirect(...)

sf_model(...)

add_model(...)

validate_model(...)

model_json(...)

model_report_template(...)

sf_items(...)

sf_scales(...)

sf_checks(...)

sf_models(...)

sf_branches(...)

sf_choice_sets(...)

sf_meta(...)

sf_plan(...)

sf_id(...)

sf_label(...)

sf_apa(...)

sf_flagged(...)

sf_problems(...)

sf_is_valid(...)

sf_object(...)

sf_missing_columns(...)

sample_size_plan(...)

sf_reference(...)

add_references(...)

sframe_references(...)

link_git_commit(...)

amendment_log(...)

render_survey(...)

export_static_survey(...)

survey_module_ui(...)

survey_module_server(...)

sframe_export_labelled(...)

quality_report(...)

missing_data_report(...)

outlier_report(...)

reliability_report(...)

item_report(...)

efa_report(...)

efa_solution(...)

validity_report(...)

descriptives_report(...)

assumption_report(...)

posthoc_report(...)

bootstrap_ci(...)

cohens_d_ci(...)

cramers_v_ci(...)

eta_sq_ci(...)

cfa_lavaan_syntax(...)

cfa_syntax(instrument, scales = NULL, std_lv = TRUE)

sem_lavaan_syntax(...)

seminr_syntax(...)

efa_syntax(...)

analysis_syntax(...)

clean_text_responses(...)

term_frequency(...)

ngram_frequency(...)

term_context(...)

extract_quotes(...)

sensitivity_analysis(...)

render_result(...)

codebook_report(...)

sframe_demos(...)

sframe_demo_data()

sframe_input_types_demo_data()

launch_builder_demo(open = TRUE)

launch_studio_demo(
  screen = "preview",
  port = NULL,
  host = "127.0.0.1",
  launch.browser = TRUE
)

preview_demo(
  name = "two_group",
  where = c("browser", "studio"),
  open = interactive()
)

sf_plan(x) <- value

launch_dashboard(
  instrument = NULL,
  responses = NULL,
  port = NULL,
  host = "127.0.0.1",
  launch.browser = interactive()
)

launch_dashboard_demo(port = NULL, host = "127.0.0.1", launch.browser = TRUE)

Arguments

...

Passed to the new function.

instrument, scales, std_lv

Passed to sframe_syntax_cfa(). instrument is also passed to launch_studio() by launch_dashboard().

open

Passed to launch_builder() or preview_survey().

screen, port, host, launch.browser

Passed to launch_studio().

name, where

Passed to preview_survey(), as its x and where.

x

An instrument.

value

The analysis plan, as for sframe_plan().

responses

A data frame of responses, passed to launch_studio().

Value

What the new function returns.

Details

Old nameNew name
sf_instrument()sframe_instrument()
sf_item()sframe_item()
sf_choices()sframe_choice_set()
sf_scale()sframe_scale()
sf_branch()sframe_branch()
sf_check()sframe_attention_check()
sf_conjoint_design()sframe_conjoint_design()
sf_construct()sframe_construct()
sf_path()sframe_path()
sf_covariance()sframe_covariance()
sf_indirect()sframe_indirect_effect()
sf_model()sframe_model_spec()
add_model()sframe_add_model()
validate_model()sframe_validate_model()
model_json()sframe_model_json()
model_report_template()sframe_model_outline()
sf_items()sframe_get_items()
sf_scales()sframe_get_scales()
sf_checks()sframe_get_attention_checks()
sf_models()sframe_get_models()
sf_branches()sframe_get_branches()
sf_choice_sets()sframe_get_choice_sets()
sf_meta()sframe_meta()
sf_plan()sframe_plan()
sf_id()sframe_id()
sf_label()sframe_label()
sf_apa()sframe_apa()
sf_flagged()sframe_flagged()
sf_problems()sframe_problems()
sf_is_valid()sframe_is_valid()
sf_object()sframe_object()
sf_missing_columns()sframe_missing_columns()
sample_size_plan()sframe_sample_size_plan()
sf_reference()sframe_reference()
add_references()sframe_add_references()
sframe_references()sframe_get_references()
link_git_commit()sframe_link_git_commit()
amendment_log()sframe_get_amendments()
render_survey()run_survey()
export_static_survey()export_survey()
survey_module_ui()sframe_survey_ui()
survey_module_server()sframe_survey_server()
sframe_export_labelled()export_responses()
quality_report()sframe_quality_results()
missing_data_report()sframe_missing_data_results()
outlier_report()sframe_outlier_results()
reliability_report()sframe_reliability_results()
item_report()sframe_item_results()
efa_report()sframe_efa_readiness_results()
efa_solution()sframe_efa_solution()
validity_report()sframe_validity_results()
descriptives_report()sframe_descriptives_results()
assumption_report()sframe_assumption_results()
posthoc_report()sframe_posthoc_results()
bootstrap_ci()sframe_bootstrap_ci()
cohens_d_ci()sframe_cohens_d_ci()
cramers_v_ci()sframe_cramers_v_ci()
eta_sq_ci()sframe_eta_sq_ci()
cfa_lavaan_syntax()sframe_syntax_cfa()
cfa_syntax()sframe_syntax_cfa()
sem_lavaan_syntax()sframe_syntax_sem()
seminr_syntax()sframe_syntax_pls()
efa_syntax()sframe_syntax_efa()
analysis_syntax()sframe_syntax_result()
clean_text_responses()sframe_clean_text()
term_frequency()sframe_term_frequency()
ngram_frequency()sframe_ngram_frequency()
term_context()sframe_term_context()
extract_quotes()sframe_extract_quotes()
sensitivity_analysis()sframe_sensitivity_analysis()
render_result()sframe_format_result()
codebook_report()sframe_codebook()
sframe_demos()sframe_list_demos()
sframe_demo_data()sframe_demo() with "tourism_services"
sframe_input_types_demo_data()sframe_demo() with "input_types"
launch_builder_demo()launch_builder() with demo = "input_types"
launch_studio_demo()launch_studio() with demo = "input_types"
preview_demo()preview_survey()
launch_dashboard()launch_studio() with screen = "dashboard"
launch_dashboard_demo()launch_studio() with demo = "input_types" and screen = "dashboard"
sf_plan(x) <- valuesframe_plan<-

Examples

# The old name and the new one make the same item
identical(sf_item("q1", "Question 1", type = "text"),
          sframe_item("q1", "Question 1", type = "text"))