Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ability to set datanames in module's constructor #821

Open
donyunardi opened this issue Dec 19, 2024 · 1 comment · May be fixed by #824
Open

Ability to set datanames in module's constructor #821

donyunardi opened this issue Dec 19, 2024 · 1 comment · May be fixed by #824
Assignees
Labels

Comments

@donyunardi
Copy link
Contributor

donyunardi commented Dec 19, 2024

Summary

Related to insightsengineering/teal#1436.

We need to review all modules to ensure there is a way for users to set datanames in the module. Upon review, we identified two modules that require updates:

  • tm_missing_data
  • tm_variable_browser

Acceptance Criteria

  • Update the design of tm_missing_data and tm_variable_browser to allow datanames to be set in the module's constructor.
  • Ensure that every module provides a way to configure datanames (via argument, data extract spec, or other means) in the module's constructor.
  • Review and update roxygen note, if necessary
@llrs-roche
Copy link
Contributor

  • tm_variable_browser: it has a datasets_selected that could be used for datanames in line with tm_data_table().
  • tm_missing_data(): Adding a datasets_selected, seems to be the most consistent approach.

Searching for other potential modules (from the 15 exported by tmg) with less flexibility on datanames:

  • tm_front_page(): Currently has an "all" or nothing approach (via show_metadata). Given the documentation and the architecture I guess the tables are meant to be created externally. But perhaps we could enable showing the metadata of only some selected datasets would be useful.
  • tm_file_viewer(): Doesn't have the option to set datanames, but I think this is fine, as the module is about files not datasets.

@llrs-roche llrs-roche linked a pull request Jan 8, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants