Methods optimization
What's new
Significant rewrite of methods and grab functionality:
- Complete removal of
event_probabilities,parameter_mapping,parameter_matrix,parents,parameters_posterior,parameters_prior,posterior_event_probabilities,type distributionandtype_priorclasses - summaries previously produced by
grabare now insummary.causal_model;summary.causal_modelclass now enhances thecausal_modelclass objects with additional summaries - print functionality previously contained in
printmethods for removed classes is now inprint.summary.causal_model; the latter takes an optionalinclude =argument that can specify set of summaries to print -
grabnow is just a wrapper forsummary.causal_modeland correspondingprintmethod - updated all places where old
grabfunctionality was used to avoid breaking the package (overall suggestion: we should not usegrabinternally and just use$operator;grabcan be viewed as user-facing convenience function)
Remaining todo:
- [ ] Review new functionality and documentation for errors
- [ ] Update tests (now all outdated tests are commented out and print as empty when testing the package)
- [ ] See if there need to be additional functionality
Important note:
summary.causal_model() can take additional arguments passed to summaries it calculates via .... That said it applies a specific argument provided (e.g. n_draws = 1000) to all summaries that can take this argument. This is done to allow grab to update the summary on the go, and grab works fine with it. But might not be ideal in general since it can affect multiple summaries when the additional argument is directly passed to summary.causal_model() call.
Amazing
Wow
Looking forward to going over; last edits by TIll and Lily were using inspect rather than grab; will check for compatibility
On Sat 14. Sep 2024 at 21:23, Georgiy (Gosha) Syunyaev < @.***> wrote:
What's new
Significant rewrite of methods and grab functionality:
- Complete removal of event_probabilities, parameter_mapping, parameter_matrix, parents, parameters_posterior, parameters_prior, posterior_event_probabilities, type distribution and type_prior classes
- summaries previously produced by grab are now in summary.causal_model; summary.causal_model class now enhances the causal_model class objects with additional summaries
- print functionality previously contained in print methods for removed classes is now in print.summary.causal_model; the latter takes an optional include = argument that can specify set of summaries to print
- grab now is just a wrapper for summary.causal_model and corresponding print method
- updated all places where old grab functionality was used to avoid breaking the package (overall suggestion: we should not use grab internally and just use $ operator; grab can be viewed as user-facing convenience function)
Remaining todo:
- Review new functionality and documentation for errors
- Update tests (now all outdated tests are commented out and print as empty when testing the package)
- See if there need to be additional functionality
Important note:
summary.causal_model() can take additional arguments passed to summaries it calculates via .... That said it applies a specific argument provided (e.g. n_draws = 1000) to all summaries that can take this argument. This is done to allow grab to update the summary on the go, and grab works fine with it. But might not be ideal in general since it can affect multiple summaries when the additional argument is directly passed to summary.causal_model() call.
You can view, comment on, or merge this pull request online at:
https://github.com/integrated-inferences/CausalQueries/pull/357 Commit Summary
- 4c2dce3 https://github.com/integrated-inferences/CausalQueries/pull/357/commits/4c2dce35ca7e925e80283f5fd0092a83bce4ae9e remove dag class but keep print method in grab
- cea2d2e https://github.com/integrated-inferences/CausalQueries/pull/357/commits/cea2d2ed793d888a2242d93683a519801126a013 exclude .h src files
- 0792c0b https://github.com/integrated-inferences/CausalQueries/pull/357/commits/0792c0b1d30fc5bf60edd6ed83782f07f07357ce weave with knitr instead of sweave
- 7779cb6 https://github.com/integrated-inferences/CausalQueries/pull/357/commits/7779cb68e0fa752263538b5fe21f1fa3fdba6852 use return() instead of direct printing
- 929c64c https://github.com/integrated-inferences/CausalQueries/pull/357/commits/929c64c83a1dae9dd4b6f12bad65707520eb4df2 remove causal_types class
- 6d07624 https://github.com/integrated-inferences/CausalQueries/pull/357/commits/6d076243dbea1a6a8bdddcc3b2189c601a9abaf7 initial edits to summary.causal_model
- 751ce63 https://github.com/integrated-inferences/CausalQueries/pull/357/commits/751ce634f3cc59d706139861d93fe7d57952d7ed remove nodal_types, parameters, parents, type_prior, nodes, statement, stan_summary classes
- bbaac88 https://github.com/integrated-inferences/CausalQueries/pull/357/commits/bbaac883832f33066bb6289135fa58481750fba3 remove print methods for removed classes and add functionality to print.summary.causal_model
- 0de3706 https://github.com/integrated-inferences/CausalQueries/pull/357/commits/0de3706fbe02d48405d64ff3e763c56746bc3c66 minor
- beb46f3 https://github.com/integrated-inferences/CausalQueries/pull/357/commits/beb46f30ba4110f5d50623ebe709e8314cb0e089 update namespace
- d62c86d https://github.com/integrated-inferences/CausalQueries/pull/357/commits/d62c86d5e64934b3e3e9cdd9fbbb7925932a2769 Updated .gitignore
- ac1ba17 https://github.com/integrated-inferences/CausalQueries/pull/357/commits/ac1ba172ebf8b6b0468b6dd576f0ca20ded8eb80 remove event_probabilities, parameter_mapping, parameter_matrix, and parents classes
- 8c3f037 https://github.com/integrated-inferences/CausalQueries/pull/357/commits/8c3f03770a9fc270a552d80eebfb92af53e1c791 move helpers
- 08c89a7 https://github.com/integrated-inferences/CausalQueries/pull/357/commits/08c89a76d344a70a2473c4cb3890a591460189b7 update summary method
- 41b8e8d https://github.com/integrated-inferences/CausalQueries/pull/357/commits/41b8e8d9efbd1d0f2fe39deab0923a09b85b0175 update namespace
- e928048 https://github.com/integrated-inferences/CausalQueries/pull/357/commits/e928048568448bf3109667a988ecc62e94d6e25a minor edits to documentation
- 172d01e https://github.com/integrated-inferences/CausalQueries/pull/357/commits/172d01ed6219860da419587b7a8079c82fcc1707 remove parameters_posterior, parameters_prior, posterior_event_probabilities, type distribution and type_prior classes and move related print methods to print.summary.causal_model
- 2a8dabd https://github.com/integrated-inferences/CausalQueries/pull/357/commits/2a8dabdc8a1990c46752f5309da05347189fa77d update namespace
- 463a6b8 https://github.com/integrated-inferences/CausalQueries/pull/357/commits/463a6b8e3fd9cd3da564ee022f44b510e7b65bd1 Revert "Updated .gitignore"
- 81ecc6f https://github.com/integrated-inferences/CausalQueries/pull/357/commits/81ecc6f102a8f0365a0dd1321e5d2b073019b98e finalize rewrite of summary.causal_models and grab
- ece42cb https://github.com/integrated-inferences/CausalQueries/pull/357/commits/ece42cbe2d5a42ffab8477c69767d8119513bdf2 temporarily fix failing tests
- 3860cbf https://github.com/integrated-inferences/CausalQueries/pull/357/commits/3860cbf58943da372ad86fc4960f2bdc9ad4fbfd update vignette to reflect new grab()
File Changes
(61 files https://github.com/integrated-inferences/CausalQueries/pull/357/files)
- M .gitignore https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-bc37d034bad564583790a46f19d807abfe519c5671395fd494d8cce506c42947 (2)
- M CausalQueries.Rproj https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-8a8c312c8386dff4e6778411491aa2b421cd8609911d13122355918778b6dca9 (2)
- M NAMESPACE https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-b6b6854a02ae177f8860f49654ff250c1554d021ae434b6efdbe99d00bdc6055 (18)
- M R/data_helpers.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-f0983ccb5090b8ce781705a1cccd0418385a2782126714938cc3e4b417271082 (2)
- M R/draw_causal_type.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-85e2d8cb3c2f5c915bb166e48f44e4d450997caf61cf560fc874de51ad66b9f2 (2)
- M R/get_event_prob.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-62fc63ea79245f51b8c7c5776431050f3b00c10f957c80d00ad496c32ecc87eb (2)
- M R/get_nodal_types.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-a952e1a39ef8c3c31ec2a3a6a18fb71f20846766b7e3a0759acfe38828cc1c80 (8)
- M R/get_parents.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-e18d93e870133ba25a8cd1305d7947ebe90daeb805a0b6a7c126e705521d8cb8 (4)
- M R/get_type_prob.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-05585d976fa9fd7f646c935cb0d667604713510e59c607b678263c874af02a23 (2)
- M R/grab.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-f0ce9d2d8df95e76e898b904614c7bb4effd541a67dc607b36a103204f15430f (203)
- M R/helpers.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-c0e4d1c45c2e1d458c837daac8876c3071b5c4794c29fcba01e3b250a8932df8 (31)
- M R/make_data.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-d16d030bdab4c7d54dbbc6dece843666d65ee3ffe024c50d7d9707b3bf50f06f (2)
- M R/make_events.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-80d0c577ddd22014c3d379f40cd137b1d144a1581b685a912174f2daac6cb094 (2)
- M R/make_models.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-bbc2b034b277547de44096413709bee14ff7ddb0810f02486cf55a64bc174687 (13)
- M R/methods.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-e85dbf7c28a289a5521fbaf2d9229d13a2d29d0b0079004555f3214ea3882cc1 (894)
- M R/parmap.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-3553151b09808107faff2b947ad7cd4b7303ab388eddda5dd4345d97def70e75 (4)
- M R/query_helpers.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-ce068019bf5dc908e03ec3742c525488f53fd6f7baf125033de7570fc9416c91 (32)
- M R/query_model.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-034ee74e0eb29968f360d97508121e8c9214f6ff23f3e755a86c4d9cf0f5309f (18)
- M R/set_parameter_matrix.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-0d6a0d0ce24b27e5b21a2619d156aa3b5cb63affb915a1e08d427cbd95867a0b (25)
- M R/set_parameters.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-79fc2b84f7cea90edb16a10005971ca819a4007dc1b9cadb071a11c9cc474d75 (4)
- M R/set_prior_distribution.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-bcb6632b56cf35ccbb1187d52cfa35e6ec14beb086ef8c80e55924b7c6fdb6ff (4)
- M R/set_restrictions.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-3081a035de7eeb87e87ca67674a20edac13ebd49f3da53e0b9f69a8c817927b1 (2)
- M R/update_model.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-83231c648dc673601448fa0c1376ded430fe2171ba2d2c4bb5b5981c00087814 (8)
- M man/draw_causal_type.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-42cbe35aebec50276425097f88118738bb16622800b32bb4953f0e50de7e0622 (2)
- M man/find_rounding_threshold.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-fb3be8fa3c48dd5fbe3d3cdd5279b79b03342ec0cac2a628a1f30044200a2aae (2)
- M man/get_all_data_types.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-0b541f54c96a1a0beec45916371dc02e8955e11e2880f1e5981bf355b2c10e24 (2)
- A man/get_args_for.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-25f103330cd4894752c7eb6b28b44070f6bd7aa4e78aa7dbb000d257e2a0e14a (16)
- M man/get_estimands.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-966be7351402c4481003b3f5215f336f0e07b147ce29ff7ce150815a59eba634 (2)
- M man/get_type_distributions.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-c7c39aa3dad1fd964f2f479fdd1eb3005baab3ffa1151003636a8c8783010878 (4)
- M man/grab.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-1d2511c10ff4d7d41b5180bff57e7e0b9d7a389c46aa0886aafdabfd56b5cb05 (108)
- M man/print.causal_model.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-59d16f06a6e37eb15dfd5474209de9c46bf3f9a0810604e0c16a4e90e9abf4a4 (2)
- D man/print.causal_types.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-68f8cdb1a8e7e34ed2d75e45a0b3bdca42c1402fe39e2495fdfd1b1743e0b168 (18)
- D man/print.dag.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-f95f737d75f53670a8441b7d1a468541f972eec6f71c5f5d3b35f3302099bc50 (18)
- D man/print.event_probabilities.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-dc7984c9824dac294f37847ceaa2320d05c31fc203db342d56c08a56a64fe55b (18)
- D man/print.nodal_types.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-fd604a0e89289adea174dfb333b9d5fe723e6b6d0bc426906438b086f70290c4 (18)
- D man/print.nodes.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-f6514ad95e9b7dd0b1e4864520b923e15ff315ecf6cd46aad7bf53592a1222e5 (18)
- D man/print.parameter_mapping.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-4691ceca3f3a3689e400a26b5ef3726cd08ff5ccbc6860518f10db604482751a (16)
- D man/print.parameters.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-1954a2a40989dcfa1ce8e6d37bc0091e77f56077c2a017c0db2f4060a2a0e0f6 (18)
- D man/print.parameters_df.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-cc0fe4ea96ae64e50a75fa1660e1a43c822b837c5ce9ecdb1e249cef08f94fe8 (18)
- D man/print.parameters_posterior.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-f272bd57f5df51168de119dff8722942f0c882cfbaec5bd3df6ace35d77b2ac5 (18)
- D man/print.parameters_prior.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-859154a050ad976c33f33d12ba5183eea6baea9a72bfbc6dd40b417d7312073b (18)
- D man/print.parents.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-07b0a1b17238b0fecd2ef12dfbf7d404525bbbf92bd517e054afb98d567d1df6 (18)
- D man/print.parents_df.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-3ed7e571c770a1033554a8f0fba5e8e510a946539be8b0496d3e08c6850e8ff7 (18)
- D man/print.posterior_event_probabilities.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-e808c170249adeebb9da3fc7d6054cd2d8162842dc8bd9a3acdb2ce20f932480 (16)
- D man/print.stan_summary.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-2ccda1ddce2f405ed056c9108a64e0b6de056ff89d334175346d1de7df107ef2 (18)
- D man/print.statement.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-29adb05a91f1756ae14541a88c9013afa4456dd09dfe1113cc05f206924b19f5 (18)
- D man/print.type_distribution.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-6d89323ea5a6f09dd1d9f8ffc39fe54f62f8e499c1c2974fb6213a6ffd6c35b5 (18)
- D man/print.type_prior.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-45c27c70f53f9d7540de4a972b90313bf7b92a13e8afb92bbe0f822cf8c77918 (18)
- M man/queries_to_types.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-552418721cd52da4008af7f95b25a2705cb508094052aa0467ad07139ae8e697 (6)
- M man/query_distribution.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-7c3857fcdf00a614ee168b3d39870db5d6aac22c7d624ba2cbba0f87a73abd11 (2)
- M man/query_model.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-22d0852bbcc8c27572d73ea4e16924ca4c0faf192223d6546c4dec7c899c1f67 (4)
- M man/summarise_distribution.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-89f5176330c0afb4c7c48540d8c0610b8f196fc1b8b60e85164d84762c9cd353 (2)
- M man/summary.causal_model.Rd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-1a6f7f8f97a6ba3aae41efb526e26e8ef038800440f50b1010aa0671a6301fe0 (98)
- M tests/testthat/test_get_posterior_distribution.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-4a12c3fc02b6e8a1441d7844d0414b92c339b5314e06f7a2d2fe0a08a10814ea (20)
- M tests/testthat/test_grab.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-a8d8ad1e3a4f6cd868e635f2f8bfe7775877e362fea9d748f17b70c2ce233ebf (197)
- M tests/testthat/test_make_model.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-94674d07ab9a9b7038281fcf447ddb7ea7ccc9bb5220c581ae2ac8cde003e30f (5)
- D tests/testthat/test_methods.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-3042422978dfd9f43cc725c6c8e790c48a7127061aaf266da6aeb31f4cdd1d47 (79)
- M tests/testthat/test_query_helpers.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-2e38b9c5b95cf78cf5130e0eab79a0dacd67535ebcc22ac9e2529267e82f5c88 (2)
- M tests/testthat/test_set_parameter_matrix.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-2b6c475acb8323d2130c1d908042c9b495b2f0746bf1d6fa1078d7a1aa690de1 (31)
- M tests/testthat/test_set_prior_distribution.R https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-6cdf03cc10791360b5f9971b3215de53527f189646cb528792a1ecef7b415a4f (8)
- M vignettes/inspecting-posteriors.Rmd https://github.com/integrated-inferences/CausalQueries/pull/357/files#diff-3a850e3af9718f9b845c9b0a43b5dbc761b692fd4fe01817aa3d8a51aaee25b1 (11)
Patch Links:
- https://github.com/integrated-inferences/CausalQueries/pull/357.patch
- https://github.com/integrated-inferences/CausalQueries/pull/357.diff
— Reply to this email directly, view it on GitHub https://github.com/integrated-inferences/CausalQueries/pull/357, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADBE57LWX65USITJBMXNYLLZWSELZAVCNFSM6AAAAABOHDDYHKVHI2DSMVQWIX3LMV43ASLTON2WKOZSGUZDMNJXGY4DEMA . You are receiving this because your review was requested.Message ID: @.***>