Package index • tflplanner

The app and its home

run_app() planner_app(): Start the tflplanner app
setup_tflplanner(): Set up tflplanner's home
tflplanner_home(): Where tflplanner keeps its settings and the studies' saved state
tflplanner_config() studies_root(): tflplanner's settings
tr() tflplanner_language() app_languages(): The app's languages

Install, update and launch

What is done at the R console: the setup, the packages, the updates and a shortcut that starts the app with a double click.

add_shortcut() remove_shortcut(): Make a shortcut that starts tflplanner
launch_app(): Start tflplanner in its own R process
update_tflplanner(): Update tflplanner, rtfreporter and tflspec
tflplanner_packages(): The packages tflplanner needs, and their versions

Company standards

standards_template() read_standards() company_standards(): Company standards
code_templates(): Code templates
setup_code(): The company's setup code
add_standard_defaults(): Add the company's study defaults a study lacks

Studies

create_study() open_study() register_study() unregister_study() list_studies(): Create, open, register and list studies
create_sample_study(): Add the sample study
save_study(): Save a study
reload_from_spec() write_spec() spec_status(): The study's definition files: read them, compare them, write them back
export_spec_files() preview_spec_import() import_spec_files(): Copy the definition files out, and bring an edited copy back
list_spec_backups() preview_spec_backup() restore_spec_backup(): Restore a study's definition from a backup
export_ars(): Export the study's analyses as CDISC ARS
study_layout(): The folder layout of a study
study_setup_code(): The study's setup program
study_files(): Files in a study folder
read_data_head(): The first rows of a data file
study_status(): What each report of a study has produced

The ARD definition and the study ARD

study_ard_conditions(): What went wrong inside the analyses while a study's ARD was made
ard_rows() set_ard_rows(): A report's rows of the ARD definition
remove_analysis(): Delete one analysis of a report
copy_analysis(): Copy one analysis of a report
set_analysis_data() remove_analysis_data() import_analysis_data() name_analysis_data() copy_analysis_data(): Add, change or remove an analysis data of the ARD definition
set_report_population(): A report's analysis set
ard_setup_code() ard_program_code() ard_autoexec_code(): The ARD programs of a study
study_helpers_code(): The functions a study's programs call
run_ard(): Run a report's analyses, or the whole study's
ard_view(): An ARD as a plain table to read
ard_status(): Where each output's ARD stands
update_study_ard(): Preview one output's ARD
study_ard(): One report's ARD, wherever it comes from

ARDs made elsewhere

import_ard(): Take an ARD made elsewhere into a study
ard_imports(): ARDs taken into a study
use_imported_ard(): Use an ARD taken in for a report, or stop using it
remove_imported_ard(): Stop using an ARD taken in
compare_imported_ard(): Compare a report's own ARD with the one taken in

ARD functions of one’s own

company_ard_functions(): The company's own ARD functions
use_company_ard_function(): Use one of the company's ARD functions in a study
check_company_ard_function(): Try one of the company's ARD functions
study_ard_functions(): A study's own ARD functions
own_ard_functions(): The ARD functions of one's own a study can use
own_function_checks(): The last try of each of a study's own ARD functions
try_ard_function(): Try one of a study's (or the company's) ARD functions
new_ard_function(): Start an ARD function of one's own from a template
take_company_ard_function(): Replace a study's copy of an ARD function with the company's

Tables, listings and figures

new_planner(): A new, empty study definition
add_output() sort_outputs() copy_output() rename_output() remove_output(): Edit the report list
output_ids(): Report ids the definition names
table_sheets() report_sheets() report_types(): Sheets of the two definition workbooks
read_codelist() set_codelist(): Read a code list into a report
import_codelist() standard_codelists(): A report's code lists: copy one in
inherited_rows(): The study default rows a report inherits
page_patterns() report_pattern() set_report_pattern(): Page patterns
add_page_pattern() rename_page_pattern() remove_page_pattern(): Make, rename or remove a page pattern
check_planner(): Check the definition the way the report programs will read it
report_info(): Where a report's program and RTF go
lf_rows() set_lf_rows() listing_types(): A listing's or figure's definition
preview_listing(): The rows of a listing, as they will print
fig_design() set_fig_design(): A figure's design (the Plot Designer)
preview_figure(): Draw a figure from its design
set_fig_ard_source(): Where a figure's ARD comes from
set_fig_own_analyses(): A figure's own analyses, written from its design
fig_presets() save_fig_preset() read_fig_preset() remove_fig_preset(): Figure presets
copy_fig_to_params(): The same figure for other parameters
step_code() set_step_code() report_datasets() set_report_datasets(): A report's own code for a step
preview_code(): Run a report's own code and see what it leaves

Reviewing a study

study_review() review_problems() review_facts(): Review a study's definition

Input assistance and the table builder

fetch_ard() ard_info() ard_data() ard_raw() ard_preview_state(): Run a report's data part and keep what its ARD holds
ard_meta(): What an ARD holds
fill_variables() fill_tables(): Fill a report's definition from its ARD
cell_presets() header_presets(): Presets for cells and column headers
add_preset(): Add a preset's rows to a report
builder_stats(): The rows the builder offers for a continuous variable
preview_pages() preview_html(): The table as it will print

Starting from the data

first_table(): Start a summary table from the data
first_hierarchy_table(): Start a hierarchical table from the data
first_shift_table(): Start a shift table from the data
first_listing(): Start a listing from the data
catalog_add_files(): Put a study's data files into its data catalog
catalog_name_clashes(): The dataset names with more than one data file
add_group_n(): Count the subjects per group for a report's column headers
set_total_column(): A Total column for a report

A TOC taken in

toc_changes(): What taking in a TOC would change
toc_apply(): Put a TOC into a study's definition
toc_populations(): The analysis set each report of a TOC names
toc_snapshot(): What a TOC said, kept for the next time one is taken in
toc_copy_profile(): Copy how a study reads its TOC to another study
toc_imports() toc_last() toc_shell_links() toc_profile(): TOCs taken into a study

A TOC taken in by the company’s rules

toc_rules() toc_rule_set() toc_map_for() toc_pick_rules(): The company's rules for taking in a TOC
toc_source() toc_find_header() toc_find_sheet() toc_rows(): A TOC's source file, read once
toc_problems() toc_import_read() toc_import_spec(): Take a TOC in by the company's rules
toc_id_candidates(): The ways a TOC's output id can be made, scored
toc_expand_phases(): One report a phase
toc_link_shells(): Each report's shell sheet
toc_batches(): The Topline batch of a TOC
toc_apply_extras(): Put what a TOC read by the rules says besides the spec into a study

Programs and runs

data_lines(): The data part of a report's program
program_code(): The R program for one report
report_setup_code(): The study's setup of its report programs
autoexec_code(): The program that runs every report program
batch_code() autoexec_all_code(): The official-run programs of a study
run_study(): Preview a study's reports
run_batch() list_batches(): Official runs of a study
batch_data_plan(): The data an official run would keep
compare_batches(): Compare two official runs
batch_sets() set_batch() rename_batch() remove_batch() batch_set_problems(): Named batches of a study's reports