wrap_single: Function to run the analysis on a single outcome

Description Usage Arguments Value

View source: R/nof1gen.wrap.R

Description

wrap_single allows the user to run an anaylsis on a specific outcome in a specific data set.

Usage

1
2
wrap_single(dataset, outcome_name, response_type, washout = TRUE,
  set_to_null = NULL)

Arguments

dataset

The dataset the analysis will be conducted on.

outcome_name

The name of the outcome the analysis will be run on.

response_type

The type of model to run. Options are: normal, binomial, poisson, or ordinal.

washout

A boolean, which indicates whether a washout period will be used or not. The default is set to TRUE.

set_to_null

A string, which indicates how many observations will be set to NA if a washout period is implemented. The default is set to NULL.

Value

The function returns some useful information about the simulation as well as information about the simulation itself.

system_info

Provides information about the clincical trial conducted. Contains

user_id

The user id for the particular patient whose data was analyzed

treatments

The names of the treatments in the trial

nof_treat

The number of different treatments that were admininstered

design

How the study was designed. How many weeks of treatment A? Of treatment B?

date_start

The start date of the study

date_end

The end date of the study

model_results

This is a list which contains the data file that was constructed using nof1.data and the result file which was created with nof1.run


arisp99/nof1gen documentation built on May 19, 2019, 9:37 p.m.