NEUBIAS / training-resources

Resources for teaching/preparing to teach bioimage analysis
https://neubias.github.io/training-resources
Other
48 stars 21 forks source link

String concatention: review and improve module #338

Open tischi opened 2 years ago

tischi commented 2 years ago

Hi @elnazfazeli ,

I did a number of changes in string contact

Are they OK for you? Please let us know!

@AnniekStok Could you please also review the module and suggest potential further improvements?

For example, maybe below exercise could be further improved to make it even more realistic (I don't think in real life one would create a variable variable1 = "sigma", would you?)? Any ideas? And maybe blurRadius instead of variable2?!

image
tischi commented 2 years ago
image

Maybe simplify this to String 1 instead of Substring 1?

AnniekStok commented 2 years ago

Hello,

I had a look and have some small comments:

Typos:

General explanation below the image. I think it might make sense to explain already here what a file separator is and how it looks on different operating systems, maybe with its own header. I think this is one of the first things that goes wrong when starting to write scripts with input/output, so I think we should explain it well (either in this module or somewhere else). For example: "Please note that when concatenating a folder and a file name into a full path, you might need to add a so-called file separator between the folder and the file name. This is a character that separates directory names within a path to a particular location on your computer. Different operating systems use different file separators: on Linux and MacOS, this is "/", while Windows uses "\". Importantly, concatenating a path on a Linux/MacOS system usually does not require you to add the "/" in between folder path and file name, because it is typically already present at the end of the folder path. On Windows, however, you often do need to add "\" in between folder path and file name. Fortunately, scripting languages typically offer special functions to help you write code that will run on all operating systems." Do we already somewhere have an explanation on escape characters and how that can get complicated with Windows paths?

Exercise 1: in step 3 and 4, it says to define variable1 and variable2, but they are named str1 and num1 which is maybe a little confusing. Maybe also add that the printed line is shown in the log window (which may be hidden in the background) and not in the script editor.

Exercise 2: Opening the blobs image is missing in the macro code

Exercise 3: I think it would not hurt to add an extra comment at the end of line 4 stating that users have to replace this with their own file path. Maybe mentioning the desktop default directories on the three most commonly used operating systems would be nice. Mac OS X: /Users/username/Desktop. Windows: C:\Users\username\Desktop (sometimes also C:/Users/username/Desktop) Linux: /home/username/Desktop.

elnazfazeli commented 2 years ago

Hi everyone. Thank you for your comments. I was wondering if one of you could help me out with the editing and finishing touches. I’m going to hospital to have our baby :-D Cheers, Elnaz

AnniekStok commented 2 years ago

All the best Elnaz! ❤️

tischi commented 2 years ago

Thanks a lot @AnniekStok .

I implemented your suggestions here: https://github.com/NEUBIAS/training-resources/commit/88f25008cc6770b3eb005fa1dc6b805121502ae7