zhaoyuanjuns/moonbit_extractor/reporting

README
U
ActivityModel
U
AuditReport
U
BalanceAudit
U
BenchmarkCase
U
BenchmarkResult
U
BinodalCurve
U
BoundaryIntersection
U
BoundaryProjection
U
CartesianPoint
U
Concentration
U
ContactPattern
U
CountercurrentResult
U
CountercurrentStage
U
CrossValidation
U
CrosscurrentLeachingResult
U
CrosscurrentResult
U
CrosscurrentStage
U
CsvOptions
U
DesignPoint
U
Duration
U
EfficiencyCalibration
U
EfficiencyStageResult
U
EfficiencyStep
U
EquilibriumCurve
U
EquilibriumPoint
U
EquilibriumTable
U
ExtractionError
U
ExtractionStep
U
Extrapolation
U
Finding
U
LeachingStage
U
LeachingStageResult
U
LedgerEntry
U
LeverResult
U
LinearTable
U
Mass
U
MassFlow
U
MassUnit
U
NumericSummary
U
Observation
U
OperatingWindow
U
PhaseSplit
U
Point
U
Range
U
RecoveryEnvelope
U
RegressionModel
U
SafetyFactor
U
ScenarioResult
U
ScenarioSummary
U
SearchResult
U
SensitivityPoint
U
Severity
U
SingleStageResult
U
SingleStageScenario
U
SolventDesign
U
StageCountResult
U
Statistics
U
SvgCanvas
U
TernaryComposition
U
TieLine
U
TieLineTable
U
TimeUnit
U
Violation
V
activity_factor
V
analysis_balance_report
V
apply_safety_factor
V
approximately_equal
V
audit_balances
V
average_recovery
V
balance_report
V
bounded_minimize
V
calibrate_efficiency
V
cartesian_grid
V
casebook
V
centroid
V
compare_contact_patterns
V
concentration_from_fraction
V
contains
V
countercurrent_constant_k
V
crosscurrent_constant_k
V
crosscurrent_equal_solvent
V
crosscurrent_equal_wash
V
crosscurrent_leach
V
distribution_coefficient
V
extraction_factor
V
fit_linear
V
fit_polynomial
V
from_cartesian
V
grid_minimize
V
is_finite
V
latin_hypercube
V
leave_one_out
V
ledger_entry
V
ledger_passes
V
lever_rule
V
linspace
V
map_unit_triangle
V
maximum_residual
V
mccabe_thiele_stages
V
minimum_countercurrent_stages
V
mix_point
V
operating_line
V
pareto_front
V
parse_equilibrium_csv
V
parse_tie_lines_csv
V
polygon_area
V
quantile
V
recommended_safety_factor
V
recovery_fraction
V
run_casebook
V
run_single_stage_scenario
V
run_single_stage_scenarios
V
sample_curve
V
selectivity
V
shortcut_actual_stages
V
single_stage_constant_k
V
single_stage_leach
V
single_stage_recovery_envelope
V
single_stage_sensitivity
V
single_stage_table
V
solvent_for_countercurrent
V
solvent_for_crosscurrent
V
solvent_for_single_stage
V
split_on_tie_line
V
stages_with_efficiency_profile
V
stages_with_uniform_efficiency
V
summarize
V
summarize_scenarios
V
sweep_distribution
V
sweep_solvent_flow
V
ternary_triangle
V
to_cartesian
V
validate_curve
V
wash_for_target

zhaoyuanjuns/moonbit_extractor/reporting does not have a README file

AuditReport

pub(all) struct AuditReport {
  name : String
  findings : Array[Finding]
  passed : Bool
  score : Double
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug)

AuditReport::add

source

fn AuditReport::add(self : AuditReport, finding : Finding) -> AuditReport

AuditReport::finding_count

source

fn AuditReport::finding_count(self : AuditReport, severity : Severity) -> Int

AuditReport::new

source

fn AuditReport::new(name~ : String) -> AuditReport

AuditReport::to_csv

source

fn AuditReport::to_csv(self : AuditReport) -> String

AuditReport::to_markdown

source

fn AuditReport::to_markdown(self : AuditReport) -> String

ExportManifest

source

pub(all) struct ExportManifest {
  format : String
  title : String
  record_count : Int
  generated_by : String
  fields : Array[String]
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug)

Finding

source

pub(all) struct Finding {
  code : String
  severity : Severity
  title : String
  detail : String
  measured : Double
  limit : Double
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug)

Finding::fail

source

fn Finding::fail(code~ : String, title~ : String, measured~ : Double, limit~ : Double, detail~ : String) -> Finding

Finding::notice

source

fn Finding::notice(code~ : String, title~ : String, measured~ : Double, limit~ : Double, detail~ : String) -> Finding

Finding::pass

source

fn Finding::pass(code~ : String, title~ : String, measured~ : Double, limit~ : Double, detail~ : String) -> Finding

KeyValue

source

pub(all) struct KeyValue {
  key : String
  value : String
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug)

Stable, machine-readable exports for reports and engineering results.

ReportBlock

source

pub(all) enum ReportBlock {
  Heading(level~ : Int, text~ : String)
  Paragraph(text~ : String)
  Bullet(items~ : Array[String])
  Table(table~ : ReportTable)
  Finding(finding~ : Finding)
  Metric(name~ : String, value~ : Double, unit~ : String)
  Divider
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug)

ReportDocument

source

pub(all) struct ReportDocument {
  title : String
  subtitle : String
  blocks : Array[ReportBlock]
  generated_by : String
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug)

ReportDocument::add

source

fn ReportDocument::add(self : ReportDocument, block : ReportBlock) -> ReportDocument

ReportDocument::block_count

source

fn ReportDocument::block_count(self : ReportDocument) -> Int

ReportDocument::bullets

source

fn ReportDocument::bullets(self : ReportDocument, items~ : Array[String]) -> ReportDocument

ReportDocument::finding

source

fn ReportDocument::finding(self : ReportDocument, finding~ : Finding) -> ReportDocument

ReportDocument::heading

source

fn ReportDocument::heading(self : ReportDocument, level~ : Int, text~ : String) -> ReportDocument raise @zhaoyuanjuns/moonbit_extractor/domain.ExtractionError
ExtractionError

ReportDocument::index

source

fn ReportDocument::index(self : ReportDocument) -> ReportIndex

ReportDocument::metric

source

fn ReportDocument::metric(self : ReportDocument, name~ : String, value~ : Double, unit~ : String) -> ReportDocument raise @zhaoyuanjuns/moonbit_extractor/domain.ExtractionError
ExtractionError

ReportDocument::new

source

fn ReportDocument::new(title~ : String, subtitle? : String, generated_by? : String) -> ReportDocument raise @zhaoyuanjuns/moonbit_extractor/domain.ExtractionError
ExtractionError

ReportDocument::paragraph

source

fn ReportDocument::paragraph(self : ReportDocument, text~ : String) -> ReportDocument

ReportDocument::summary

source

fn ReportDocument::summary(self : ReportDocument) -> String

ReportDocument::table

source

fn ReportDocument::table(self : ReportDocument, table~ : ReportTable) -> ReportDocument

ReportDocument::to_markdown

source

fn ReportDocument::to_markdown(self : ReportDocument) -> String

ReportIndex

source

pub(all) struct ReportIndex {
  title : String
  section_count : Int
  metric_count : Int
  table_count : Int
  failure_count : Int
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug)

ReportTable

source

pub(all) struct ReportTable {
  title : String
  columns : Array[String]
  rows : Array[Array[String]]
  numeric_columns : Array[Bool]
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug)

A typed table used in engineering reports.

ReportTable::add_row

source

fn ReportTable::add_row(self : ReportTable, row : ArrayView[String]) -> ReportTable raise @zhaoyuanjuns/moonbit_extractor/domain.ExtractionError
ExtractionError

ReportTable::column_count

source

fn ReportTable::column_count(self : ReportTable) -> Int

ReportTable::new

source

fn ReportTable::new(title~ : String, columns~ : ArrayView[String], numeric_columns? : ArrayView[Bool]) -> ReportTable raise @zhaoyuanjuns/moonbit_extractor/domain.ExtractionError
ExtractionError

ReportTable::row_count

source

fn ReportTable::row_count(self : ReportTable) -> Int

ReportTable::rows

source

fn ReportTable::rows(self : ReportTable) -> Array[Array[String]]

ReportTable::to_csv

source

fn ReportTable::to_csv(self : ReportTable) -> String

ReportTable::to_markdown

source

fn ReportTable::to_markdown(self : ReportTable) -> String

Severity

source

pub(all) enum Severity {
  Pass
  Notice
  Fail
} derive(Eq, ToJson, @moonbitlang/core/debug.Debug
Debug)

Human- and machine-readable audit summaries for process studies.

analysis_balance_report

source

fn analysis_balance_report(summary : @zhaoyuanjuns/moonbit_extractor/analysis.BalanceAudit
BalanceAudit, tolerance~ : Double) -> AuditReport raise @zhaoyuanjuns/moonbit_extractor/domain.ExtractionError
ExtractionError

Build a report from the analysis package's aggregate balance audit.

balance_report

source

fn balance_report(name~ : String, residuals : ArrayView[Double], tolerance~ : Double) -> AuditReport raise @zhaoyuanjuns/moonbit_extractor/domain.ExtractionError
ExtractionError

document_csv

source

fn document_csv(document : ReportDocument) -> String

document_html

source

fn document_html(document : ReportDocument) -> String

document_json_lines

source

fn document_json_lines(document : ReportDocument) -> String

document_manifest

source

fn document_manifest(document : ReportDocument, format : String) -> ExportManifest

document_outline

source

fn document_outline(document : ReportDocument) -> Array[String]

document_plain_text

source

fn document_plain_text(document : ReportDocument) -> String

escape_json_text

source

fn escape_json_text(value : String) -> String

export_checksum

source

fn export_checksum(text : String) -> String

key_value_json

source

fn key_value_json(values : ArrayView[KeyValue]) -> String

manifest_json

source

fn manifest_json(manifest : ExportManifest) -> String

manifest_summary

source

fn manifest_summary(manifest : ExportManifest) -> String

report_export

source

fn report_export(document : ReportDocument, format : String) -> String raise @zhaoyuanjuns/moonbit_extractor/domain.ExtractionError
ExtractionError

report_export_formats

source

fn report_export_formats() -> Array[String]

report_from_audit

source

fn report_from_audit(title~ : String, audit : AuditReport) -> ReportDocument raise @zhaoyuanjuns/moonbit_extractor/domain.ExtractionError
ExtractionError

report_has_format

source

fn report_has_format(format : String) -> Bool

table_to_html

source

fn table_to_html(table : ReportTable) -> String

table_to_tsv

source

fn table_to_tsv(table : ReportTable) -> String

Source Files

Site source Report issue Packages Build queue Skills Statistics

#AuditReport

#AuditReport::add

#AuditReport::finding_count

#AuditReport::new

#AuditReport::to_csv

#AuditReport::to_markdown

#ExportManifest

#Finding

#Finding::fail

#Finding::notice

#Finding::pass

#KeyValue

#ReportBlock

#ReportDocument

#ReportDocument::add

#ReportDocument::block_count

#ReportDocument::bullets

#ReportDocument::finding

#ReportDocument::heading

#ReportDocument::index

#ReportDocument::metric

#ReportDocument::new

#ReportDocument::paragraph

#ReportDocument::summary

#ReportDocument::table

#ReportDocument::to_markdown

#ReportIndex

#ReportTable

#ReportTable::add_row

#ReportTable::column_count

#ReportTable::new

#ReportTable::row_count

#ReportTable::rows

#ReportTable::to_csv

#ReportTable::to_markdown

#Severity

#analysis_balance_report

#balance_report

#document_csv

#document_html

#document_json_lines

#document_manifest

#document_outline

#document_plain_text

#escape_json_text

#export_checksum

#key_value_json

#manifest_json

#manifest_summary

#report_export

#report_export_formats

#report_from_audit

#report_has_format

#table_to_html

#table_to_tsv

Source Files

AuditReport

AuditReport::add

AuditReport::finding_count

AuditReport::new

AuditReport::to_csv

AuditReport::to_markdown

ExportManifest

Finding

Finding::fail

Finding::notice

Finding::pass

KeyValue

ReportBlock

ReportDocument

ReportDocument::add

ReportDocument::block_count

ReportDocument::bullets

ReportDocument::finding

ReportDocument::heading

ReportDocument::index

ReportDocument::metric

ReportDocument::new

ReportDocument::paragraph

ReportDocument::summary

ReportDocument::table

ReportDocument::to_markdown

ReportIndex

ReportTable

ReportTable::add_row

ReportTable::column_count

ReportTable::new

ReportTable::row_count

ReportTable::rows

ReportTable::to_csv

ReportTable::to_markdown

Severity

analysis_balance_report

balance_report

document_csv

document_html

document_json_lines

document_manifest

document_outline

document_plain_text

escape_json_text

export_checksum

key_value_json

manifest_json

manifest_summary

report_export

report_export_formats

report_from_audit

report_has_format

table_to_html

table_to_tsv