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

Update get_data notebook in runtime documentation to use napa style identifiers #598

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

Conversation

PeopleMakeCulture
Copy link
Collaborator

@PeopleMakeCulture PeopleMakeCulture commented Jul 17, 2024

Description

Updates documentation notebook to use napa style identifiers

Fixes user research issue #34

Type of change

  • Documentation update

How Has This Been Tested?

All cells ran successfully on local jupyter server

Configuration Details: none

Definition of Done (DoD) Checklist:

A simple checklist of necessary activities that add verifiable/demonstrable value to the product by asserting the quality of a feature, not the functionality of that feature; the latter should be stated as acceptance criteria in the issue this PR closes. Not all activities in the PR template will be applicable to each feature since the definition of done is intended to be a comprehensive checklist. Consciously decide the applicability of value-added activities on a feature-by-feature basis.

  • My code follows the style guidelines of this project (have you run black nmdc_runtime/?)
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (in docs/ and in https://github.com/microbiomedata/NMDC_documentation/?)
  • I have added tests that prove my fix is effective or that my feature works, incl. considering downstream usage (e.g. https://github.com/microbiomedata/notebook_hackathons) if applicable.
  • New and existing unit and functional tests pass locally with my changes (make up-test && make test-run)

docs/nb/get_data.ipynb Outdated Show resolved Hide resolved
@@ -503,7 +490,7 @@
"\n",
" return local_filename\n",
"\n",
"id_biosample = \"igsn:IEWFS000A\"\n",
"id_biosample = \"igsn:IEWFS000A\" #UPDATE\n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"id_biosample = \"igsn:IEWFS000A\" #UPDATE\n",
"id_biosample = \"nmdc:bsm-11-mbnqn650\"\n",

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new ID for igsn:IEWFS000A is nmdc:bsm-11-mbnqn650

Copy link
Contributor

@aclum aclum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See individual comments.

" 'id': 'nmdc:839560f9650622f232c262d8cf7a9db9',\n",
" 'started_at_time': '2022-05-31T12:26:24-07:00',\n",
" 'type': 'nmdc:MetatranscriptomeAssembly'}]\n"
"\n"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@PeopleMakeCulture can you remove this keyboard interruption text?

@aclum
Copy link
Contributor

aclum commented Oct 21, 2024

@PeopleMakeCulture do you have time to revisit this PR?

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.

Update get_data notebook in runtime docs to use napa style identifiers
2 participants