Skip to content

MVP: Implement the calc_nobs utility function #13

@dougbrn

Description

@dougbrn

Feature request
Blocks #9. To demonstrate how more-domain specific functions can be built and interact with the core package, we should implement calc_nobs in a separate utility module (or utils of NestedFrame). The implementation should follow TAPE: https://tape.readthedocs.io/en/latest/autoapi/tape/index.html#tape.Ensemble.calc_nobs, and usage should look like this:

from nested_frame.utils import calc_nobs

nf = calc_nobs(nf, "my_nested", by="band")

Because we don't have column intuition via column mapping (a la TAPE), I think it's best to have a "by" kwarg that groups by unique values of the given column and returns columns for each group. Potentially annoying if a user chooses the wrong column as this could produce a lot of columns.

Before submitting
Please check the following:

  • I have described the purpose of the suggested change, specifying what I need the enhancement to accomplish, i.e. what problem it solves.
  • I have included any relevant links, screenshots, environment information, and data relevant to implementing the requested feature, as well as pseudocode for how I want to access the new functionality.
  • If I have ideas for how the new feature could be implemented, I have provided explanations and/or pseudocode and/or task lists for the steps.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions