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

consider creating a GH action that can run this workflow with mock data #6

Closed
cjyetman opened this issue Mar 21, 2023 · 15 comments
Closed
Labels

Comments

@cjyetman
Copy link
Member

it would be ideal to have some automated CI running here

@jdhoffa
Copy link
Member

jdhoffa commented Mar 22, 2023

Let's make a friggin mock data repo!!!!! that would be a huge immediate gain IMO
@fariiaakh @AlexAxthelm

@fariiaakh
Copy link

A mock data repo that creates mock data?

@jdhoffa
Copy link
Member

jdhoffa commented Mar 22, 2023

Indeed! Similar to: https://github.com/RMI-PACTA/r2dii.data
But for pacta.data.preparation inputs

(Alternatively we can potentially bundle it in with pacta.data.preparation, I just envision a future where we may want the mock data in another context)

@cjyetman
Copy link
Member Author

hopefully the repo is not "mock" and just the data is 😆

@cjyetman
Copy link
Member Author

I think this might fit in well with pacta.data.validation

@jdhoffa
Copy link
Member

jdhoffa commented Mar 22, 2023

^ Agree

@cjyetman
Copy link
Member Author

tagging this as blocked until such mock data exists (which is arguably much more difficult than creating the GH action that would use it)

@cjyetman
Copy link
Member Author

Once pacta.data.preparation is public (https://github.com/RMI-PACTA/pacta.data.preparation/issues/283), I think we will move towards a GH action that runs this with real data, in which case this issue will be no longer relevant? @jdhoffa

@AlexAxthelm
Copy link
Collaborator

I think this remains relevant, since the "mock data" version is then effectively part of our public documentation / quickstart guide

@jdhoffa
Copy link
Member

jdhoffa commented Mar 14, 2024

Yeah definitely agreed, template data is very useful in any case IMO

@cjyetman
Copy link
Member Author

Would it be appropriate for this repo to "mock" its input data as a sort of documentation, rather than the repo that makes them?

@AlexAxthelm
Copy link
Collaborator

I think that would be the right call

@cjyetman
Copy link
Member Author

hmmm.... I think the thing that creates something should document what it creates, rather than all the things that use it.

@jdhoffa
Copy link
Member

jdhoffa commented Mar 14, 2024

I agree with @AlexAxthelm on this one, the package should clearly document/ mock its inputs.

If you have a function f(x) -> y, and a mocked input x, you can easily determine y.
If on the other hand, you document the outputs, then you have y and the function f(x), but you can't (easily) determine x.

@cjyetman
Copy link
Member Author

closing in favor of RMI-PACTA/archive.pacta.data.preparation#190

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants