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

Order data to match the data request #65

Open
wants to merge 84 commits into
base: main
Choose a base branch
from
Open

Conversation

mandresm
Copy link
Contributor

Thank you for contributing! 🎉

Summary of the most important changes

Please summarize the most important changes you have made in this PR.

Usage example in the PR

Please put a small usage example in the PR body so that we can see what you want to do.

You can include python:

from pymorize.cmorizer import CMORizer
cmorizer = CMORizer()
cmorizer.process()

An example with Rules:

>>> # Assume you have a Rule with these attributes:
>>> rule = Rule()
>>> rule.name = "My Rule"
>>> rule.description = "This is my rule"
>>> # Some input data
>>> data = pd.DataFrame({"A": [1, 2, 3], "B": [4, 5, 6]})
>>> # Using my new step in the PR:
>>> data = my_new_step(data, rule)
>>> data
... # Add what the data should look like

These sorts of examples should also be in the docstrings of your code!

Checklist

  • I have tested the changes in this PR.
  • I have updated the documentation.
  • If I have made a new step which requires new arguments, these are added to the validate.py file
    so that the user can see documentation for the arguments.

Copilot Summary

If you have Github Co-Pilot, please include an automatically generated summary.

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

Successfully merging this pull request may close these issues.

3 participants