-
Notifications
You must be signed in to change notification settings - Fork 56
/
yaml_write.R
1666 lines (1462 loc) · 46.3 KB
/
yaml_write.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#------------------------------------------------------------------------------#
#
# _ _ _ _ _
# (_) | | | | | | | |
# _ __ ___ _ _ __ | |_ | |__ | | __ _ _ __ | | __
# | '_ \ / _ \ | || '_ \ | __|| '_ \ | | / _` || '_ \ | |/ /
# | |_) || (_) || || | | || |_ | |_) || || (_| || | | || <
# | .__/ \___/ |_||_| |_| \__||_.__/ |_| \__,_||_| |_||_|\_\
# | |
# |_|
#
# This file is part of the 'rstudio/pointblank' project.
#
# Copyright (c) 2017-2024 pointblank authors
#
# For full copyright and license information, please look at
# https://rstudio.github.io/pointblank/LICENSE.html
#
#------------------------------------------------------------------------------#
#' Write **pointblank** objects to YAML files
#'
#' @description
#'
#' With `yaml_write()` we can take different **pointblank** objects (these are
#' the `ptblank_agent`, `ptblank_informant`, and `tbl_store`) and write them to
#' YAML. With an *agent*, for example, `yaml_write()` will write that everything
#' that is needed to specify an *agent* and it's validation plan to a YAML file.
#' With YAML, we can modify the YAML markup if so desired, or, use as is to
#' create a new agent with the [yaml_read_agent()] function. That *agent* will
#' have a validation plan and is ready to [interrogate()] the data. We can go a
#' step further and perform an interrogation directly from the YAML file with
#' the [yaml_agent_interrogate()] function. That returns an agent with intel
#' (having already interrogated the target data table). An *informant* object
#' can also be written to YAML with `yaml_write()`.
#'
#' One requirement for writing an *agent* or an *informant* to YAML is that we
#' need to have a table-prep formula specified (it's an R formula that is used
#' to read the target table when [interrogate()] or [incorporate()] is called).
#' This option can be set when using [create_agent()]/[create_informant()] or
#' with [set_tbl()] (useful with an existing agent or informant object).
#'
#' @param ... *Pointblank agents, informants, table stores*
#'
#' `<series of obj:<ptblank_agent|ptblank_informant|tbl_store>>`
#' // **required**
#'
#' Any mix of **pointblank** objects such as the *agent*
#' (`ptblank_agent`), the *informant* (`ptblank_informant`), or the table
#' store (`tbl_store`). The agent and informant can be combined into a single
#' YAML file (so long as both objects refer to the same table). A table store
#' cannot be combined with either an agent or an informant so it must undergo
#' conversion alone.
#'
#' @param .list *Alternative to `...`*
#'
#' `<list of multiple expressions>` // **required** (or, use `...`)
#'
#' Allows for the use of a list as an input alternative to `...`.
#'
#' @param filename *File name*
#'
#' `scalar<character>` // *default:* `NULL` (`optional`)
#'
#' The name of the YAML file to create on disk. It is recommended that either
#' the `.yaml` or `.yml` extension be used for this file. If not provided then
#' default names will be used (`"tbl_store.yml"`) for a table store and the
#' other objects will get default naming to the effect of
#' `"<object>-<tbl_name>.yml"`.
#'
#' @param path *File path*
#'
#' `scalar<character>` // *default:* `NULL` (`optional`)
#'
#' An optional path to which the YAML file should be saved (combined with
#' `filename`).
#'
#' @param expanded *Expand validation when repeating across multiple columns*
#'
#' `scalar<logical>` // *default:* `FALSE`
#'
#' Should the written validation expressions for an *agent* be expanded such
#' that **tidyselect** expressions for columns are evaluated, yielding a
#' validation function per column? By default, this is `FALSE` so expressions
#' as written will be retained in the YAML representation.
#'
#' @param quiet *Inform (or not) upon file writing*
#'
#' `scalar<logical>` // *default:* `FALSE`
#'
#'. Should the function *not* inform when the file is written?
#'
#' @return Invisibly returns `TRUE` if the YAML file has been written.
#'
#' @section Examples:
#'
#' ## Writing an `agent` object to a YAML file
#'
#' Let's go through the process of developing an agent with a validation plan.
#' We'll use the `small_table` dataset in the following examples, which will
#' eventually offload the developed validation plan to a YAML file.
#'
#' ```{r}
#' small_table
#' ```
#'
#' Creating an `action_levels` object is a common workflow step when creating a
#' **pointblank** agent. We designate failure thresholds to the `warn`, `stop`,
#' and `notify` states using [action_levels()].
#'
#' ```r
#' al <-
#' action_levels(
#' warn_at = 0.10,
#' stop_at = 0.25,
#' notify_at = 0.35
#' )
#' ```
#'
#' Now let's create the `agent` and pass it the `al` object (which serves as a
#' default for all validation steps which can be overridden). The data will be
#' referenced in `tbl` with a leading `~` and this is a requirement for writing
#' to YAML since the preparation of the target table must be self contained.
#'
#' ```r
#' agent <-
#' create_agent(
#' tbl = ~ small_table,
#' tbl_name = "small_table",
#' label = "A simple example with the `small_table`.",
#' actions = al
#' )
#' ```
#'
#' Then, as with any `agent` object, we can add steps to the validation plan by
#' using as many validation functions as we want.
#'
#' ```r
#' agent <-
#' agent %>%
#' col_exists(columns = c(date, date_time)) %>%
#' col_vals_regex(
#' columns = b,
#' regex = "[0-9]-[a-z]{3}-[0-9]{3}"
#' ) %>%
#' rows_distinct() %>%
#' col_vals_gt(columns = d, value = 100) %>%
#' col_vals_lte(columns = c, value = 5)
#' ```
#'
#' The agent can be written to a **pointblank**-readable YAML file with the
#' `yaml_write()` function. Here, we'll use the filename
#' `"agent-small_table.yml"` and, after writing, the YAML file will be in the
#' working directory:
#'
#' ```r
#' yaml_write(agent, filename = "agent-small_table.yml")
#' ```
#'
#' We can view the YAML file in the console with the [yaml_agent_string()]
#' function.
#'
#' ```r
#' yaml_agent_string(filename = "agent-small_table.yml")
#' ```
#'
#' ```yaml
#' type: agent
#' tbl: ~small_table
#' tbl_name: small_table
#' label: A simple example with the `small_table`.
#' lang: en
#' locale: en
#' actions:
#' warn_fraction: 0.1
#' stop_fraction: 0.25
#' notify_fraction: 0.35
#' steps:
#' - col_exists:
#' columns: c(date, date_time)
#' - col_vals_regex:
#' columns: c(b)
#' regex: '[0-9]-[a-z]{3}-[0-9]{3}'
#' - rows_distinct:
#' columns: ~
#' - col_vals_gt:
#' columns: c(d)
#' value: 100.0
#' - col_vals_lte:
#' columns: c(c)
#' value: 5.0
#' ```
#'
#' Incidentally, we can also use [yaml_agent_string()] to print YAML in the
#' console when supplying an agent as the input. This can be useful for
#' previewing YAML output just before writing it to disk with `yaml_write()`.
#'
#' ## Reading an `agent` object from a YAML file
#'
#' There's a YAML file available in the **pointblank** package that's also
#' called `"agent-small_table.yml"`. The path for it can be accessed through
#' `system.file()`:
#'
#' ```r
#' yml_file_path <-
#' system.file(
#' "yaml", "agent-small_table.yml",
#' package = "pointblank"
#' )
#' ```
#'
#' The YAML file can be read as an agent with a pre-existing validation plan by
#' using the [yaml_read_agent()] function.
#'
#' ```r
#' agent <- yaml_read_agent(filename = yml_file_path)
#'
#' agent
#' ```
#'
#' \if{html}{
#' \out{
#' `r pb_get_image_tag(file = "man_yaml_write_1.png")`
#' }
#' }
#'
#' This particular agent is using `~ tbl_source("small_table", "tbl_store.yml")`
#' to source the table-prep from a YAML file that holds a table store (can be
#' seen using `yaml_agent_string(agent = agent)`). Let's put that file in the
#' working directory (the **pointblank** package has the corresponding YAML
#' file):
#'
#' ```r
#' yml_tbl_store_path <-
#' system.file(
#' "yaml", "tbl_store.yml",
#' package = "pointblank"
#' )
#'
#' file.copy(from = yml_tbl_store_path, to = ".")
#' ```
#'
#' As can be seen from the validation report, no interrogation was yet
#' performed. Saving an agent to YAML will remove any traces of interrogation
#' data and serve as a plan for a new interrogation on the same target table. We
#' can either follow this up with with [interrogate()] and get an agent with
#' intel, or, we can interrogate directly from the YAML file with
#' [yaml_agent_interrogate()]:
#'
#' ```r
#' agent <- yaml_agent_interrogate(filename = yml_file_path)
#'
#' agent
#' ```
#'
#' \if{html}{
#' \out{
#' `r pb_get_image_tag(file = "man_yaml_write_2.png")`
#' }
#' }
#'
#' ## Writing an `informant` object to a YAML file
#'
#' Let's walk through how we can generate some useful information for a really
#' small table. We can create an `informant` object with [create_informant()]
#' and we'll again use the `small_table` dataset.
#'
#' ```r
#' informant <-
#' create_informant(
#' tbl = ~ small_table,
#' tbl_name = "small_table",
#' label = "A simple example with the `small_table`."
#' )
#' ```
#'
#' Then, as with any `informant` object, we can add info text to the
#' using as many `info_*()` functions as we want.
#'
#' ```r
#' informant <-
#' informant %>%
#' info_columns(
#' columns = a,
#' info = "In the range of 1 to 10. (SIMPLE)"
#' ) %>%
#' info_columns(
#' columns = starts_with("date"),
#' info = "Time-based values (e.g., `Sys.time()`)."
#' ) %>%
#' info_columns(
#' columns = date,
#' info = "The date part of `date_time`. (CALC)"
#' )
#' ```
#'
#' The informant can be written to a **pointblank**-readable YAML file with the
#' `yaml_write()` function. Here, we'll use the filename
#' `"informant-small_table.yml"` and, after writing, the YAML file will be in
#' the working directory:
#'
#' ```r
#' yaml_write(informant, filename = "informant-small_table.yml")
#' ```
#'
#' We can inspect the YAML file in the working directory and expect to see the
#' following:
#'
#' ```yaml
#' type: informant
#' tbl: ~small_table
#' tbl_name: small_table
#' info_label: A simple example with the `small_table`.
#' lang: en
#' locale: en
#' table:
#' name: small_table
#' _columns: 8
#' _rows: 13.0
#' _type: tbl_df
#' columns:
#' date_time:
#' _type: POSIXct, POSIXt
#' info: Time-based values (e.g., `Sys.time()`).
#' date:
#' _type: Date
#' info: Time-based values (e.g., `Sys.time()`). The date part of `date_time`.
#' a:
#' _type: integer
#' info: In the range of 1 to 10. (SIMPLE)
#' b:
#' _type: character
#' c:
#' _type: numeric
#' d:
#' _type: numeric
#' e:
#' _type: logical
#' f:
#' _type: character
#' ```
#'
#' ## Reading an `informant` object from a YAML file
#'
#' There's a YAML file available in the **pointblank** package that's also
#' called `"informant-small_table.yml"`. The path for it can be accessed through
#' `system.file()`:
#'
#' ```r
#' yml_file_path <-
#' system.file(
#' "yaml", "informant-small_table.yml",
#' package = "pointblank"
#' )
#' ```
#'
#' The YAML file can be read as an informant by using the
#' [yaml_read_informant()] function.
#'
#' ```r
#' informant <- yaml_read_informant(filename = yml_file_path)
#'
#' informant
#' ```
#'
#' \if{html}{
#' \out{
#' `r pb_get_image_tag(file = "man_yaml_write_3.png")`
#' }
#' }
#'
#' As can be seen from the information report, the available table metadata was
#' restored and reported. If you expect metadata to change with time, it might
#' be beneficial to use [incorporate()] to query the target table. Or, we can
#' perform this querying directly from the YAML file with
#' [yaml_informant_incorporate()]:
#'
#' ```r
#' informant <- yaml_informant_incorporate(filename = yml_file_path)
#' ```
#'
#' There will be no apparent difference in this particular case since
#' `small_data` is a static table with no alterations over time. However,
#' using [yaml_informant_incorporate()] is good practice since this refreshing
#' of data will be important with real-world datasets.
#'
#' @family pointblank YAML
#' @section Function ID:
#' 11-1
#'
#' @export
yaml_write <- function(
...,
.list = list2(...),
filename = NULL,
path = NULL,
expanded = FALSE,
quiet = FALSE
) {
# Collect a list of pointblank objects
obj_list <- .list
# Determine which types of pointblank objects
# are available in `obj_list`
object_types <-
vapply(
obj_list,
FUN.VALUE = character(1),
USE.NAMES = FALSE,
FUN = function(x) {
if (inherits(x, "ptblank_agent")) {
x <- "agent"
} else if (inherits(x, "ptblank_informant")) {
x <- "informant"
} else if (inherits(x, "tbl_store")) {
x <- "tbl_store"
} else {
x <- NA_character_
}
}
)
if ("tbl_store" %in% object_types) {
tbl_store <- obj_list[[object_types == "tbl_store"]]
x <- as_tbl_store_yaml_list(tbl_store = tbl_store)
if (is.null(filename)) {
filename <- "tbl_store.yml"
}
if (!is.null(path)) {
filename <- file.path(path, filename)
}
yaml::write_yaml(
x = x,
file = filename,
handlers = list(
logical = function(x) {
result <- ifelse(x, "true", "false")
class(result) <- "verbatim"
result
}
)
)
# Generate cli message w.r.t. written YAML file
if (!quiet) {
cli_bullet_msg(
msg = "The table store YAML file has been written to `{filename}`",
bullet = cli::symbol$tick,
color = "green"
)
}
return(invisible(TRUE))
}
if ("agent" %in% object_types) {
agent <- obj_list[[object_types == "agent"]]
} else {
agent <- NULL
}
if ("informant" %in% object_types) {
informant <- obj_list[[object_types == "informant"]]
} else {
informant <- NULL
}
if (is.null(agent) && is.null(informant)) {
stop(
"An agent or informant object must be supplied to `yaml_write()`.",
call. = FALSE
)
}
if (!is.null(agent) && !is.null(informant)) {
x <-
c(
as_agent_yaml_list(agent = agent, expanded = expanded),
as_informant_yaml_list(informant = informant)
)
# TODO: combine with tbl name (e.g., `pointblank-<tbl_name>.yml`)
if (is.null(filename)) {
filename <- "pointblank.yml"
}
yaml_type <- "agent and informant"
# TODO: manage conflicts between both YAML representations
} else if (!is.null(agent)) {
x <- as_agent_yaml_list(agent = agent, expanded = expanded)
if (is.null(filename)) {
if (!is.null(agent$tbl_name) && !is.na(agent$tbl_name)) {
filename <- paste0("agent-", agent$tbl_name, ".yml")
} else {
filename <- "agent.yml"
}
}
yaml_type <- "agent"
} else {
x <- as_informant_yaml_list(informant = informant)
if (is.null(filename)) {
if (!is.null(informant$tbl_name) && !is.na(informant$tbl_name)) {
filename <- paste0("informant-", informant$tbl_name, ".yml")
} else {
filename <- "informant.yml"
}
}
yaml_type <- "informant"
}
if (!is.null(path)) {
filename <- file.path(path, filename)
}
# Write the YAML to disk
yaml::write_yaml(
x = x,
file = filename,
handlers = list(
logical = function(x) {
result <- ifelse(x, "true", "false")
class(result) <- "verbatim"
result
}
)
)
# Generate cli message w.r.t. written YAML file
if (!quiet) {
cli_bullet_msg(
msg = "The {yaml_type} YAML file has been written to `{filename}`",
bullet = cli::symbol$tick,
color = "green"
)
}
invisible(TRUE)
}
#' Display **pointblank** YAML using an agent or a YAML file
#'
#' @description
#'
#' With **pointblank** YAML, we can serialize an agent's validation plan (with
#' [yaml_write()]), read it back later with a new agent (with
#' [yaml_read_agent()]), or perform an interrogation on the target data table
#' directly with the YAML file (with [yaml_agent_interrogate()]). The
#' `yaml_agent_string()` function allows us to inspect the YAML generated by
#' [yaml_write()] in the console, giving us a look at the YAML without needing
#' to open the file directly. Alternatively, we can provide an *agent* to the
#' `yaml_agent_string()` and view the YAML representation of the validation plan
#' without needing to write the YAML to disk beforehand.
#'
#' @param agent An *agent* object of class `ptblank_agent`. If an object is
#' provided here, then `filename` must not be provided.
#'
#' @param filename The name of the YAML file that contains fields related to an
#' *agent*. If a file name is provided here, then *agent* object must not be
#' provided in `agent`.
#'
#' @param path An optional path to the YAML file (combined with `filename`).
#'
#' @param expanded Should the written validation expressions for an *agent* be
#' expanded such that **tidyselect** expressions for columns are evaluated,
#' yielding a validation function per column? By default, this is `FALSE`
#' so expressions as written will be retained in the YAML representation.
#'
#' @return Nothing is returned. Instead, text is printed to the console.
#'
#' @section Examples:
#'
#' There's a YAML file available in the **pointblank** package that's called
#' `"agent-small_table.yml"`. The path for it can be accessed through
#' `system.file()`:
#'
#' ```r
#' yml_file_path <-
#' system.file(
#' "yaml", "agent-small_table.yml",
#' package = "pointblank"
#' )
#' ```
#'
#' We can view the contents of the YAML file in the console with the
#' `yaml_agent_string()` function.
#'
#' ```r
#' yaml_agent_string(filename = yml_file_path)
#' ```
#'
#' ```yaml
#' type: agent
#' tbl: ~ tbl_source("small_table", "tbl_store.yml")
#' tbl_name: small_table
#' label: A simple example with the `small_table`.
#' lang: en
#' locale: en
#' actions:
#' warn_fraction: 0.1
#' stop_fraction: 0.25
#' notify_fraction: 0.35
#' steps:
#' - col_exists:
#' columns: vars(date)
#' - col_exists:
#' columns: vars(date_time)
#' - col_vals_regex:
#' columns: vars(b)
#' regex: '[0-9]-[a-z]{3}-[0-9]{3}'
#' - rows_distinct:
#' columns: ~
#' - col_vals_gt:
#' columns: vars(d)
#' value: 100.0
#' - col_vals_lte:
#' columns: vars(c)
#' value: 5.0
#' ```
#'
#' Incidentally, we can also use `yaml_agent_string()` to print YAML in the
#' console when supplying an *agent object* as the input. This can be useful for
#' previewing YAML output just before writing it to disk with [yaml_write()].
#'
#' @family pointblank YAML
#' @section Function ID:
#' 11-5
#'
#' @export
yaml_agent_string <- function(
agent = NULL,
filename = NULL,
path = NULL,
expanded = FALSE
) {
switch(
rlang::check_exclusive(agent, filename),
agent = {
# Display the agent's YAML as a nicely formatted string by
# generating the YAML (`as_agent_yaml_list() %>% as.yaml()`) and
# then emitting it to the console via `message()`
message(
as_agent_yaml_list(
agent = agent,
expanded = expanded
) %>%
yaml::as.yaml(
handlers = list(
logical = function(x) {
result <- ifelse(x, "true", "false")
class(result) <- "verbatim"
result
}
)
)
)
},
filename = {
# Display the agent's YAML as a nicely formatted string by
# reading the YAML file specified by `file` (and perhaps `path`)
# and then emitting it to the console via `message()`
if (!is.null(path)) {
filename <- file.path(path, filename)
}
message(
readLines(filename) %>%
paste(collapse = "\n")
)
}
)
}
as_c_fn <- function(columns) {
columns <- strsplit(unlist(columns), ", ")[[1]]
paste0("c(", paste0('"', columns, '"', collapse = ", "), ")")
}
as_list_preconditions <- function(preconditions) {
if (is.null(preconditions[[1]])) {
return(NULL)
} else if (is.function(preconditions[[1]])) {
return(
paste(deparse(preconditions[[1]]), collapse = "\n") %>%
gsub("function (x) \n{", "function(x) {", ., fixed = TRUE)
)
}
as.character(preconditions)
}
as_list_segments <- function(segments) {
if (is.null(segments[[1]])) {
return(NULL)
}
segments <- unlist(segments)
components <- c()
for (i in seq_along(segments)) {
if (rlang::is_formula(segments[[i]]) &&
!inherits(segments[[i]], "quosure")) {
components <-
c(components, paste(capture_formula(segments[[i]]), collapse = " "))
} else if (inherits(segments[[i]], "quosure")) {
components <-
c(components, paste0("vars(", as_label(segments[[i]]), ")"))
}
}
paste0("list(", paste(components, collapse = ", "), ")")
}
as_list_active <- function(active) {
if (is.logical(active[[1]])) {
return(active[[1]])
}
as.character(active)
}
to_list_action_levels <- function(actions) {
agent_actions <- actions
agent_actions[sapply(agent_actions, is.null)] <- NULL
agent_actions$fns[sapply(agent_actions$fns, is.null)] <- NULL
if (length(agent_actions$fns) == 0) agent_actions$fns <- NULL
if (length(agent_actions$fns) == 0) {
agent_actions$fns <- NULL
} else {
agent_actions$fns <-
lapply(
agent_actions$fns,
FUN = function(x) {
if (!is.null(x)) x %>% as.character() %>% paste(collapse = "")
}
)
}
list(actions = agent_actions)
}
as_action_levels <- function(actions, actions_default = NULL) {
agent_actions <- actions
agent_actions[sapply(agent_actions, is.null)] <- NULL
agent_actions$fns[sapply(agent_actions$fns, is.null)] <- NULL
if (length(agent_actions$fns) == 0) {
agent_actions$fns <- NULL
} else {
agent_actions$fns <-
lapply(
agent_actions$fns,
FUN = function(x) {
if (!is.null(x)) x %>% as.character() %>% paste(collapse = "")
}
)
}
if (!is.null(actions_default)) {
if (identical(agent_actions, actions_default)) {
return(NULL)
}
}
agent_actions
}
get_schema_list <- function(schema) {
vals <- schema
complete <- schema$`__complete__`
in_order <- schema$`__in_order__`
is_exact <- schema$`__is_exact__`
type <- ifelse(inherits(schema, "r_type"), "r", "sql")
vals <-
vals[!(names(vals) %in% c("__complete__", "__in_order__", "__is_exact__"))]
if (type == "sql") {
vals <- c(vals, list(`.db_col_types` = "sql"))
}
list(
schema = vals,
complete = complete,
in_order = in_order,
is_exact = is_exact
)
}
to_list_read_fn <- function(read_fn) {
if (inherits(read_fn, "function")) {
read_fn_char <- utils::capture.output(read_fn)
} else {
read_fn_char <- paste(as.character(read_fn), collapse = "")
}
list(tbl = read_fn_char)
}
to_list_label <- function(label) {
list(label = label)
}
to_list_fn <- function(fn) {
list(fn = fn)
}
to_list_info_label <- function(label) {
list(info_label = label)
}
to_list_tbl_name <- function(tbl_name) {
if (is.na(tbl_name)) {
tbl_name <- NULL
}
list(tbl_name = tbl_name)
}
get_arg_value <- function(value) {
if (inherits(value, "list") && inherits(value[[1]], "quosures")) {
out <- paste0("vars(", rlang::as_label(value[[1]][[1]]), ")")
} else if (inherits(value, "list") && inherits(value[[1]], "numeric")) {
out <- value[[1]]
} else {
out <- as.character(value[[1]])
}
out
}
get_arg_value_lr <- function(value) {
if (inherits(value, "quosure")) {
out <- paste0("vars(", rlang::as_label(value), ")")
} else if (inherits(value, "numeric")) {
out <- value
} else {
out <- as.character(value)
}
out
}
prune_lst_step <- function(lst_step) {
if (
"preconditions" %in% names(lst_step[[1]]) &&
is.null(lst_step[[1]][["preconditions"]])
) {
lst_step[[1]]["preconditions"] <- NULL
}
if (
"segments" %in% names(lst_step[[1]]) &&
is.null(lst_step[[1]][["segments"]])
) {
lst_step[[1]]["segments"] <- NULL
}
if (
"na_pass" %in% names(lst_step[[1]]) &&
!lst_step[[1]][["na_pass"]]
) {
lst_step[[1]]["na_pass"] <- NULL
}
if (
"active" %in% names(lst_step[[1]]) &&
lst_step[[1]][["active"]] == "TRUE"
) {
lst_step[[1]]["active"] <- NULL
}
if (
"complete" %in% names(lst_step[[1]]) &&
lst_step[[1]][["complete"]]
) {
lst_step[[1]]["complete"] <- NULL
}
if (
"inclusive" %in% names(lst_step[[1]]) &&
(lst_step[[1]][["inclusive"]][1] && lst_step[[1]][["inclusive"]][2])
) {
lst_step[[1]]["inclusive"] <- NULL
}
if (
"in_order" %in% names(lst_step[[1]]) &&
lst_step[[1]][["in_order"]]
) {
lst_step[[1]]["in_order"] <- NULL
}
if (
"is_exact" %in% names(lst_step[[1]]) &&
lst_step[[1]][["is_exact"]]
) {
lst_step[[1]]["is_exact"] <- NULL
}
if (
"allow_stationary" %in% names(lst_step[[1]]) &&
!lst_step[[1]][["allow_stationary"]]
) {
lst_step[[1]]["allow_stationary"] <- NULL
}
if (
"decreasing_tol" %in% names(lst_step[[1]]) &&
is.null(lst_step[[1]][["decreasing_tol"]])
) {
lst_step[[1]]["decreasing_tol"] <- NULL
}
if (
"increasing_tol" %in% names(lst_step[[1]]) &&
is.null(lst_step[[1]][["increasing_tol"]])
) {
lst_step[[1]]["increasing_tol"] <- NULL
}
if ("actions" %in% names(lst_step[[1]])) {
if (
length(lst_step[[1]][["actions"]][["action_levels"]]) == 1 &&
length(lst_step[[1]][["actions"]][["action_levels"]][["fns"]]) == 0
) {
lst_step[[1]][["actions"]] <- NULL
} else if (is.null(lst_step[[1]][["actions"]])) {
lst_step[[1]][["actions"]] <- NULL
}
}
if ("label" %in% names(lst_step[[1]]) && is.na(lst_step[[1]][["label"]])) {
lst_step[[1]]["label"] <- NULL
}
lst_step
}
as_agent_yaml_list <- function(agent, expanded) {
if (is.null(agent$read_fn)) {
stop(
"The agent must have a `tbl` value that can be put into YAML.",
call. = FALSE
)
}
action_levels_default <- as_action_levels(agent$actions)
end_fns <- agent$end_fns %>% unlist()
lst_label <- to_list_label(agent$label)
lst_tbl_name <- to_list_tbl_name(agent$tbl_name)
lst_read_fn <- to_list_read_fn(agent$read_fn)
if (is.null(action_levels_default)) {
lst_action_levels <- NULL
} else {
lst_action_levels <- list(actions = action_levels_default)
}
if (is.null(end_fns)) {
lst_end_fns <- NULL
} else {
lst_end_fns <- list(end_fns = as.character(end_fns))
}
if (is.null(agent$embed_report) ||
(!is.null(agent$embed_report) && !agent$embed_report)) {
lst_embed_report <- NULL
} else {
lst_embed_report <- list(embed_report = agent$embed_report)
}