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

Documentation: Questionnaires vignette intro needs updating #2586

Closed
manciniedoardo opened this issue Nov 29, 2024 · 8 comments
Closed

Documentation: Questionnaires vignette intro needs updating #2586

manciniedoardo opened this issue Nov 29, 2024 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@manciniedoardo
Copy link
Collaborator

Please select a category the issue is focused on?

User Guides

Let us know where something needs a refresh or put your idea here!

The intro to the Questionnaires ADaM User Guide reads:

At the moment, admiral does not provide functions or metadata for specific questionnaires nor functionality for handling the vast amount of questionnaires and related parameters, e.g. a metadata structure for storing parameter definitions and functions for reading such metadata. We plan to provide it in future releases.

I don't think this is accurate anymore. I propose to just cut, and if anything say only that specific questionnaires are sometimes addressed in extension packages.

@bms63 thoughts?

@manciniedoardo manciniedoardo added the documentation Improvements or additions to documentation label Nov 29, 2024
@manciniedoardo manciniedoardo self-assigned this Nov 29, 2024
@manciniedoardo manciniedoardo changed the title Documentation: Questionnaires vignette Documentation: Questionnaires vignette intro needs updating Nov 29, 2024
@bundfussr
Copy link
Collaborator

@manciniedoardo , why do you think it is not accurate anymore?

If extension packages provide something for specific questionnaires, we could add a reference on the questionnaires vignette.

@bms63
Copy link
Collaborator

bms63 commented Dec 1, 2024

I be interested in highlighting some of the power of the extension packages for questionnaires!

The intro/statement still sounds true to me??

@manciniedoardo
Copy link
Collaborator Author

@manciniedoardo , why do you think it is not accurate anymore?

If extension packages provide something for specific questionnaires, we could add a reference on the questionnaires vignette.

Sorry, I probably should have specified what I meant by not accurate. To my knowledge, this bit "e.g. a metadata structure for storing parameter definitions and functions for reading such metadata. We plan to provide it in future releases." is inaccurate as we don't have plans. As you guys mention I'd rather highlight the power of ext packages.

@bms63
Copy link
Collaborator

bms63 commented Dec 2, 2024

ooohhh the mention of the json file for grading stuff has me thinking more on this...maybe we do have a "plan" :)

@manciniedoardo
Copy link
Collaborator Author

maybe an item for our 2025 roadmap?

@bms63
Copy link
Collaborator

bms63 commented Dec 2, 2024

love it!

@manciniedoardo
Copy link
Collaborator Author

Have added to my notes, will close this issue for now.

@bms63
Copy link
Collaborator

bms63 commented Dec 2, 2024

Is this going in a 1.3 - 2.0 Roadmap Discussion thread!?!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

No branches or pull requests

3 participants