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

Add a README.md #2

Closed
pbchase opened this issue Dec 31, 2024 · 2 comments
Closed

Add a README.md #2

pbchase opened this issue Dec 31, 2024 · 2 comments

Comments

@pbchase
Copy link
Contributor

pbchase commented Dec 31, 2024

Add a README.md that reflects the repo description ("Fill a REDCap project with generated data based on the project design and a minimal set of inputs") and this text

Project goals and audience

This project aims to generate ample, rich test data for a new REDCap with little to no effort. This supports testing and development that requires data as input. It supports reporting writing when reports could need numerous records and rich input variation. It supports the creation of non-identifiable test data and the demonstration of REDCap functionality. It supports tests for missing data and bad data.
The audience for this package is R developers working in REDCap shops. They could use it to create data for their own development needs and the needs of their REDCap Admins and customers.

Limitations

This package is not a substitute for interactive testing of REDCap forms and surveys. For example, it cannot complete a survey through a survey engine.

This document will be the root page of the package documentation when we start writing vignettes. It should describe the feature set of the first release, but very little more.

Futures

We can have a "Futures" section, but it should be brief. The details of those futures should be described in Github issues and milestones. At the moment, the project plan is described at REDCapFilleR Design Notes

@pbchase
Copy link
Contributor Author

pbchase commented Dec 31, 2024

https://ouhscbbmc.github.io/REDCapR/index.html has a good model for README content

@pbchase
Copy link
Contributor Author

pbchase commented Jan 3, 2025

Addressed by PR #10

@pbchase pbchase closed this as completed Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant