MLMI2-CSSI / MLMI2-CSSI/foundry

Implement `FoundryDataset.to_pandas()`

Open
#428 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
88
Forks
17
PR merge metrics
No merged PRs in 30d

Description

As a user, I want to load a dataset as a pandas dataframe.

Assumptions:

A user finds the dataset they want by running this code:

f = Foundry()
datasets = f.search("DOI.123/445")

assert len(datasets) == 1
res = datasets[0].get_as_dict()

Instead of using get_as_dict(), the user wants to get the dataset as a pandas dataframe. Create a method get_as_pandas to allow the user to download the data in this format.

Acceptance Criteria

Given I know what dataset I want to use, when I specify that I want it in a pandas format, then the data downloads in the format I specified.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating FoundryDataset and its existing get_as_dict method, then inspect how the search result in the issue retrieves dataset data. Confirm whether the public method should be named to_pandas or get_as_pandas, since the title and body differ. Done means the acceptance scenario can retrieve the selected dataset as a pandas dataframe.

Written by the indexing model from the issue text.

Assessment

Tech stack
pandas, python
Domain
data
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.