[Doc enhancement]: Nan explanation

Open Beginner friendly
#643 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
pandas, python
Domain
documentation

Research direction

Start with the linked “Starting With Data” lesson at 02-starting-with-data.html and review where surveys.csv and the weight column are introduced. Add a clear explanation of NaNs, how missing values appear in the lesson data, and simple ways to identify them, with links or references to the later visualization and multiplication examples; the lesson should make the affected examples understandable to learners using their own data.

Written by the indexing model from the issue text.

Description

How could the content be improved?

Query / Context:
When in the "Starting With Data" section, a surveys.csv is used but the file is incomplete so when read in using pandas the dataframe fills in the blanks with Nans as expected. Nans don't look to be discussed on this episode or prior episodes in series and can be seen in screenshots for the episode. Additionally, the weight column which is used to show pandas functions for metrics has prominent number of Nans in starting rows.

Suggested improvement:
Include documentation and explanation of what Nans are. This would be good as links into the challenges for visualisation later why 1 group doesn't have a bar and later a column with Nans in the first rows is used for multiplication example. When discussing csv structure or when first load in data could be a good point to introduce concept (and if time few simple commands to check for nans) as can show the lack of values in raw/table display and then in pandas preview.

Additional context:
As people will want to use what have learnt for own data, explaining what nans are and maybe how to identify them would help as a lot of analysis can be wrong or break if include nans and plenty of errors relating to Nans.

Screenshots from lesson:


Image
Image

Example of column weight usage which has high number of nans so not true representation of all records:

Image
Image
Which part of the content does your suggestion apply to?

https://datacarpentry.github.io/python-ecology-lesson/02-starting-with-data.html

Dominant language
Jupyter Notebook
Stars
176
Forks
316
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

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.

More from datacarpentry/python-ecology-lesson

All issues in datacarpentry/python-ecology-lesson

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.