Trial visualization

See also: Services.

TrialVisualization

Returned by: ContributionAnalysisService.add_selectors, ContributionAnalysisService.clear, ContributionAnalysisService.replace, ContributionAnalysisService.set_all_baseline, ContributionAnalysisService.set_custom_baseline, ContributionAnalysisService.set_input_baseline_only, ContributionAnalysisService.set_quantile, ContributionAnalysisService.set_selectors, DataOverlayService.add_table, DataOverlayService.clear, DataOverlayService.replace, DataOverlayService.set_ranges_enabled, DataOverlayService.set_tables, FiltersService.add_categorical, FiltersService.add_numeric, FiltersService.add_patient_list, FiltersService.clear, FiltersService.replace, GroupsService.add_categorical_grouping, GroupsService.add_scalar_bin_count_grouping, GroupsService.add_scalar_bin_width_grouping, GroupsService.add_scalar_distinct_grouping, GroupsService.add_scalar_explicit_grouping, GroupsService.add_scalar_quantile_grouping, GroupsService.clear, GroupsService.replace, GroupsService.set_group_by_arm, JinkoClient.create_trial_visualization_from_json, JinkoClient.get_trial_visualization, JinkoClient.iter_trial_visualizations, JinkoClient.list_trial_visualizations, OverlayService.add_descriptors, OverlayService.add_patients, OverlayService.clear, OverlayService.replace, OverlayService.set, ScalarsService.add_selectors, ScalarsService.clear, ScalarsService.replace, ScalarsService.set_selectors, ScatterPlotsService.add_x_vs_x_plot, ScatterPlotsService.add_x_vs_y_plot, ScatterPlotsService.clear, ScatterPlotsService.replace, ScatterPlotsService.set_config, ScatterPlotsService.set_regression, SurvivalAnalysisService.add_selectors, SurvivalAnalysisService.clear, SurvivalAnalysisService.replace, SurvivalAnalysisService.set_confidence_interval, SurvivalAnalysisService.set_observation_window_from_start_until_end, SurvivalAnalysisService.set_observation_window_from_start_until_time, SurvivalAnalysisService.set_selectors, TimeseriesService.add_selectors, TimeseriesService.clear, TimeseriesService.replace, TimeseriesService.set_selectors, Trial.create_empty_trial_visualization, Trial.create_trial_visualization_from_json, TrialVisualization.clear_selected_arms, TrialVisualization.set_equate_baseline, TrialVisualization.set_selected_arms, TrialVisualization.set_time_unit

Also has every member of ProjectItem.

Member	Kind	Description
source_trial	property
sanity	property
sanity_at	method
set_selected_arms	method
clear_selected_arms	method
set_equate_baseline	method
set_time_unit	method
filters	property
groups	property
timeseries	property
scalars	property
scatter_plots	property
survival_analysis	property
contribution_analysis	property
data_overlay	property
patients_overlay	property

source_trial

Type: Trial

sanity

Type: TrialVisualizationSanityView

sanity_at

sanity_at(
    revision: int, *, only: list[str] | None = None
) -> TrialVisualizationSanityView

set_selected_arms

set_selected_arms(
    arms: list[str] | tuple[str, ...] | None,
    *,
    version: str | dict | None = None
) -> TrialVisualization

clear_selected_arms

clear_selected_arms(
    *, version: str | dict | None = None
) -> TrialVisualization

set_equate_baseline

set_equate_baseline(
    enabled: bool, *, version: str | dict | None = None
) -> TrialVisualization

set_time_unit

set_time_unit(
    unit: TrialVisualizationTimeUnit | str, *, version: str | dict | None = None
) -> TrialVisualization

filters

Type: FiltersService

groups

Type: GroupsService

timeseries

Type: TimeseriesService

scalars

Type: ScalarsService

scatter_plots

Type: ScatterPlotsService

survival_analysis

Type: SurvivalAnalysisService

contribution_analysis

Type: ContributionAnalysisService

data_overlay

Type: DataOverlayService

patients_overlay

Type: OverlayService

TrialVisualizationSanityEntry

Returned by: TrialVisualizationSanityView.by_field

Member	Kind	Description
field	attribute
severity	attribute
items	attribute
reason	attribute

field

Type: TrialVisualizationSanityFieldName

severity

Type: TrialVisualizationSanitySeverity

items

Type: tuple[str, ...]

reason

Type: str

TrialVisualizationSanityView

Returned by: TrialVisualization.sanity, TrialVisualization.sanity_at, TrialVisualizationSanityView.errors, TrialVisualizationSanityView.for_field, TrialVisualizationSanityView.from_openapi, TrialVisualizationSanityView.warnings

Member	Kind	Description
from_openapi	classmethod
errors	method
warnings	method
has_errors	method
for_field	method
by_field	method

from_openapi

TrialVisualizationSanityView.from_openapi(sanity: openapi_types.TrialVisualizationSanity) -> TrialVisualizationSanityView

errors

errors() -> TrialVisualizationSanityView

warnings

warnings() -> TrialVisualizationSanityView

has_errors

has_errors() -> bool

for_field

for_field(*fields: TrialVisualizationSanityFieldName = ()) -> TrialVisualizationSanityView

by_field

by_field() -> (
    dict[TrialVisualizationSanityFieldName, list[TrialVisualizationSanityEntry]]
)