Student cloning instructions

jhudsl / AnVIL_Template

An OTTR spinoff template for creating AnVIL content

https://jhudatascience.org/AnVIL_Template/

Creative Commons Attribution 4.0 International

0 stars 1 forks source link

Student cloning instructions #170

Closed KatherineCox closed 1 year ago

KatherineCox commented 2 years ago

Similar to #169, here's an attempt at student instructions for cloning.

This lets you configure the Workspace name in the parent document, and then inserts the name in the student instructions. If this seems overly complicated, we can drop it. Partly I just wanted to see if this would even work, and, hey, it does! :)

github-actions[bot] commented 2 years ago

The check: spelling errors is currently being re-run :runner: Comment updated at 2022-12-07 with changes from a72518ef345cf5ce0c9b794c521fb14f24235118

github-actions[bot] commented 2 years ago

The check: broken urls is currently being re-run :runner: Comment updated at 2022-12-07 with changes from a72518ef345cf5ce0c9b794c521fb14f24235118

github-actions[bot] commented 2 years ago

Re-rendered previews from the latest commit:

See preview of Bookdown here
See preview of Coursera/Leanpub version here
Download the preview of .docx file

Updated at 2022-12-07 with changes from 901348740aeb5cb8660f687261e61aef416cfd62

avahoffman commented 2 years ago

LOVE THIS!!!! 🤩

My only concern is that the screenshots will always refer to the SARS workspace, even if the instructor specifies some other workspace. Could that potentially be confusing? Maybe some text like "in the example below we are finding the 'SARS Genome' Workspace" ... something like that?

Also agree with @ehumph that we might want out.width = '100%'... not sure what the default is.

KatherineCox commented 2 years ago

image sizing - done! thanks @avahoffman for saving me a Google search :)

I've added :

(The images below show the SARS-CoV-2-Genome Workspace as an example, but you should look for the Workspace r workspace_name.)

to try to address potential confusion. I agree showing the SARS workspace is non-ideal, wish I could magically update the images too.

Perhaps at some point it would be good to redo the screenshots with a workspace named something like "Example_Student_Workspace", to make it more obvious that it's just an example. Then we could also put something in the Dashboard for that workspace saying "Hey...did you really mean to clone me?".

(I actually considered doing this just now, but then hesitated because we'd need to make it public so that it shows up under the PUBLIC tab, so it probably needs a bit more thought/effort beyond just giving it a name)

avahoffman commented 1 year ago

Great! I have a few more comments.

I made a PR here: #174

First thing is the ability to add an "example" div box. I think it helps (me at least) visualize where the borrowed text starts and stops
Third chunk is missing the module settings
If you define AnVIL_module_settings in one chunk, they persist to the next chunk used. This could be a problem if someone sets variables on chunk 1 but doesn't want them on chunk 2. Added a comment to make that clear.

KatherineCox commented 1 year ago

@avahoffman I was able to set AnVIL_module_settings to NULL at the end of the child using <<-. There's a demo of it working in #175, but the PR was getting messy with the adjustments I had to make to get it to render a preview, so I went ahead and made the changes in this branch. Look okay?

avahoffman commented 1 year ago

@KatherineCox sounds great! Let's remove these instructions, then: https://github.com/jhudsl/AnVIL_Template/blob/e64e48f579e9ffab75f0c43df13dba4b26735af4/08-student_modules.Rmd#L39

KatherineCox commented 1 year ago

@KatherineCox sounds great! Let's remove these instructions, then:

https://github.com/jhudsl/AnVIL_Template/blob/e64e48f579e9ffab75f0c43df13dba4b26735af4/08-student_modules.Rmd#L39

Oh, good catch, thanks! Done.