User Guide
Reference
Demos
Blog
Changelog
API
/
DataScan.save_to_json()
API Index
Validate
Validate
Thresholds
Actions
FinalActions
Schema
DraftValidation
EditValidation
MissingSpec
Contracts and Pipelines
Contract
Step
Pipeline
PipelineResult
Contract Import/Export
import_contract
export_contract
list_adapters
register_adapter
ContractImport
ContractAdapter
Validation Steps
Validate.col_vals_gt
Validate.col_vals_lt
Validate.col_vals_ge
Validate.col_vals_le
Validate.col_vals_eq
Validate.col_vals_ne
Validate.col_vals_between
Validate.col_vals_outside
Validate.col_vals_in_set
Validate.col_vals_not_in_set
Validate.col_vals_increasing
Validate.col_vals_decreasing
Validate.col_vals_null
Validate.col_vals_not_null
Validate.col_vals_regex
Validate.col_vals_within_spec
Validate.col_vals_expr
Validate.col_exists
Validate.col_pct_null
Validate.col_pct_missing
Validate.col_missing_coded
Validate.col_missing_only_coded
Validate.col_missing_consistent
Validate.rows_distinct
Validate.rows_complete
Validate.col_schema_match
Validate.row_count_match
Validate.col_count_match
Validate.data_freshness
Validate.tbl_match
Validate.conjointly
Validate.specially
Validate.prompt
Aggregation Steps
Validate.col_sum_gt
Validate.col_sum_lt
Validate.col_sum_ge
Validate.col_sum_le
Validate.col_sum_eq
Validate.col_avg_gt
Validate.col_avg_lt
Validate.col_avg_ge
Validate.col_avg_le
Validate.col_avg_eq
Validate.col_sd_gt
Validate.col_sd_lt
Validate.col_sd_ge
Validate.col_sd_le
Validate.col_sd_eq
Column Selection
col
starts_with
ends_with
contains
matches
everything
first_n
last_n
expr_col
Segment Groups
seg_group
Interrogation and Reporting
Validate.interrogate
Validate.set_tbl
Validate.get_tabular_report
Validate.get_step_report
Validate.get_json_report
Validate.get_dataframe_report
Validate.to_code
Validate.to_yaml
Validate.suggest_improvements
Validate.from_prompt
Validate.get_sundered_data
Validate.get_data_extracts
Validate.all_passed
Validate.assert_passing
Validate.assert_below_threshold
Validate.assert_dimension_scores
Validate.above_threshold
Validate.get_dimension_scores
Validate.get_health_score
Validate.get_scorecard
Validate.n
Validate.n_passed
Validate.n_failed
Validate.f_passed
Validate.f_failed
Validate.warning
Validate.error
Validate.critical
Inspection and Assistance
DataScan
preview
col_summary_tbl
missing_vals_tbl
load_dataset
get_data_path
connect_to_table
print_database_tables
DataScan Methods
DataScan.summary_data
DataScan.get_tabular_report
DataScan.to_dict
DataScan.to_json
DataScan.save_to_json
DataScan.from_dict
DataScan.from_json
DataScan.load_from_json
DataScan.compare
Table Pre-checks
has_columns
has_rows
YAML
yaml_interrogate
validate_yaml
yaml_to_python
Utility Functions
get_column_count
get_row_count
get_action_metadata
get_validation_summary
write_file
read_file
ref
Test Data Generation
generate_dataset
schema_from_tbl
int_field
float_field
string_field
bool_field
date_field
datetime_field
time_field
duration_field
profile_fields
Prebuilt Actions
send_slack_notification
emit_otel
Metadata Import/Export
import_metadata
export_metadata
MetadataImport
MetadataPackage
VariableMetadata
Codelist
CodelistEntry
MissingValueCode
SDTM Validation
validate_sdtm
validate_sdtm_structure
sdtm_to_metadata
get_sdtm_domain
list_sdtm_domains
SDTMDomainTemplate
SDTMVariableSpec
ADaM Validation
validate_adam
validate_adam_structure
adam_to_metadata
get_adam_dataset
list_adam_datasets
ADaMDatasetTemplate
ADaMVariableSpec
CDISC Submission Conformance
validate_sdtmig
validate_cdisc_submission
SubmissionPackage
ConformanceReport
Integrations
integrations.otel.OTelExporter
On this page
Parameters
DataScan.save_to_json()
Save the profile to a JSON file.
Usage
Source
DataScan
.
save_to_json
(
output_file
)
Parameters
output_file
:
str
The path to the output JSON file.