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

Cutoff for Exercisename #30

Open
MartinKies opened this issue Jul 3, 2020 · 3 comments
Open

Cutoff for Exercisename #30

MartinKies opened this issue Jul 3, 2020 · 3 comments

Comments

@MartinKies
Copy link
Contributor

I ran into to the warning that my exercise names are identical. The reason for this was that only the first 20 characters are used for the comparison. Something like

Konfidenzintervalle Teil 1
Konfidenzintervalle Teil 2

e.g. is therefore not possible without generating the warning and having sub-optimal chunk-names.

I set the limit to 99 in my fork and as far as I see there were no negative consequences and everything works as intended now.

Is there a specific reason for the limitation to 20 characters which might result in undesired behavior down the line if one weakens it to 99 chars?

@skranz
Copy link
Owner

skranz commented Jul 3, 2020

This code concerns the automatic generation of chunk names. I don't want to have chunk names that are too long, because they are shown in a Markdown version of the problem set and also are used to name all HTML identifiers (perhaps performance goes down a bit, if all IDs are super long). I changed RTutor just now in a different fashion. Chunks are now just named with the exercise counter as a prefix instead of the 20 first characters of the exercise name. Makes more sense and the IDs are even shorter now. You also should not have any problems with your exercise names anymore.

@MartinKies
Copy link
Contributor Author

I integrated your changes and all technical aspects work fine.

I am however worried about maintainability down the line and effects on the transparency of the submission files if the course is actively in development. (Which by the way is broadly our plan: To have constant and continuous improvement on all courses to achieve maximum quality and keeping them up-to-date)

Take for example a course (or course chapter) where there exist several exercises. One of the exercises shall be expanded. This in turn makes it to long for easy digestion. It is split up in two parts. As a result all later chunks get renamed. Even though no change took place in the later exercises they can't trivially be matched across problem set versions, making it harder to analyze the submission files of a course.

Especially regarding the submission files it might be helpful to include (possibly optional) additional indicators to the chunks/Exercises (be it in sub$by.chunk, sub$by.ex and/or in sub$log.txt). One could for example include the name of the Exercise as an additional column to the data frames. I think this would be a comparatively cheap but powerful change.
Ideally one could additionally set optional names to chunks which are persistent and not subject to changes of the exercise name and earlier chunks. This would make it more time-consuming to build the problem set but a lot easier to have say graphical and in depth analyses even for problem sets which change very dynamically.

@skranz
Copy link
Owner

skranz commented Jul 6, 2020

I don't see that this is problematic. If you have different versions of your problem set (and continuous improvement is definitely a good idea) then you should also keep for every version the corresponding rps file and the Rmd solution file. Using the rps file you can always match the chunks to the corresponding exercises. I think that at some functions of RTutorSAGI for analysing the solutions require anyway that you provide the corresponding rps file.

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

No branches or pull requests

2 participants