datacarpentry / semester-biology

Forkable teaching materials for course on working with data in R
http://datacarpentry.org/semester-biology
Other
76 stars 111 forks source link

Numbered list #884

Closed garezana closed 4 years ago

garezana commented 4 years ago

Edited for clarity and change 2.2046 to 2.20462 to remove approximately.

Please delete this line and the text below before submitting your contribution.


Thanks for contributing! If this contribution is for instructor training, please send an email to checkout@carpentries.org with a link to this contribution so we can record your progress. You’ve completed your contribution step for instructor checkout just by submitting this contribution.

Please keep in mind that lesson maintainers are volunteers and it may be some time before they can respond to your contribution. Although not all contributions can be incorporated into the lesson materials, we appreciate your time and effort to improve the curriculum. If you have any questions about the lesson maintenance process or would like to volunteer your time as a contribution reviewer, please contact The Carpentries Team at team@carpentries.org.


ethanwhite commented 4 years ago

Thanks @garezana. We use numbered lists to indicate subexercises (e.g., https://datacarpentry.org/semester-biology/exercises/Expressions-and-variables-basic-expressions-R/), so we need to avoid that structure for this exercise.

I think we also need to reference the original code in some way, because otherwise students will wonder why they were shown that code in the first place.

What do you think about something like:

Create a similar piece of code to convert a mass in pounds to kg.

  • The first line should
  • The second line should
  • The third line should

I also think we should also remote the parenthetical statement about the rabbit (I used to think this kind of detail helped group things, but I think they actually get in the way for most beginners).

I'd probably also shorten the second bullet to something like:

Convert the variable from body mass in pounds to body mass in kilograms (by dividing it by 2.20462) and assign it to a new variable.

Lastly, if we change the divisor, this will change the solution, so we need to update the code solution in the solutions repo and the text solution in the solutions directory in this repo (I think it would also be fine to just leave the extra digit to avoid the extra work, but I'm happy either way).

garezana commented 4 years ago

Create a similar piece of code to convert a mass in pounds to kg.

  • The first line should
    • The second line should
    • The third line should

Adding the reference does make it clearer.

I also think we should also remove the parenthetical statement about the rabbit (I used to think this kind of detail helped group things, but I think they actually get in the way for most beginners).

I think it makes it seem more relevant for the field and gives the exercise some context. Maybe remove the size word as it makes me think of volume and not mass.

Maybe something like:

Create a variable to store a body mass in pounds. Assign this variable a value of 3.5 (an appropriate mass for a Sylvilagus audubonii).

Create a variable to store a body mass in pounds. Assign this variable a value of 3.5

Removing it makes it seem too x=value.

Lastly, if we change the divisor, this will change the solution, so we need to update the code solution in the solutions repo and the text solution in the solutions directory in this repo

Originally the text said:

Convert this value to kilograms. There are approximately 2.2046 lbs in a kilogram, so divide the variable storing the weight in pounds by 2.2046 and store this value in a new variable for storing mass in kilograms.

Tried to make the instruction shorter by removing the: "store value in a variable for storing" and changing "approximately 2.2046" to 2.20462 . Which was what submitted yesterday with a consistency note and why i asked on dependencies yesterday to not do this mistake again.

garezana commented 4 years ago

Pushed again integrating suggestions.

ethanwhite commented 4 years ago

Looks great! Thanks!