Anum's Suggested Changes

[dvirlar2]

• Custom Units: In the Edit Factors section, there's an Edit Custom Units section which talks about how to add custom units using a function. Using Shiny to add custom units is my go-to method, so I think it might be helpful to include some code that shows how you can add custom units using Shiny (including screenshots of what the Shiny app looks like when the tab is open and maybe arrows pointing at important cells. Shiny app also has multiple tables, like custom units, factor, etc. so including that can be helpful too)

• Physicals: I remember when I first started, I was really confused about physicals 😂 I think in the section where it talks about physicals, it would be good to include a screenshot of a physical section and highlighting each part. For example, "here is the Entity name, which matches the Object name...Here is the number of header liners which is the number of lines in the data table before the data starts..."

• Chapter Organization: I noticed in the training manual, section 4.5 is Edit Datatables, 4.6 is Edit otherEntities, and then 4.7 is Semantic annotations. Perhaps Semantic annotations could be in the section near where the attribute section is. I think also emphasizing more that attributes should be added first before converting to datatables is helpful.

• Adding Attributes: I think the 4.3.1 Edit Attributes section is a little confusing, since I usually add attributes in the web editor. But adding attributes using a function I think makes them into datatables which is less steps? I think maybe emphasizing more that it can be done in the webeditor is helpful, and then after adding attributes, you can convert to datatables

  • Takeaway: Emphasizing workflow, and creativity/flexibility in solving problems using either R or the web editor so interns know they can and are encouraged to do whatever is most straightforward!

• Abbreviations: Having a list of common abbreviations or things that should be defined in abstracts/methods would be helpful (for example, m should be defined as meters). I know this would require a lot of time so maybe just a list of the abbreviations themselves ("m", "cm", "km", or just the complicated, yet well-known acronyms) would still be helpful.

• Workflow: Lastly, I remember when I first started working on my first ticket, I had trouble with getting the workflow down. I would do things out of order accidentally lol so maybe including the workflow code (get the package, get id, etc....update the awards, convert otherEntities to datatables, add physicals, add fair principles, add discipline categorization, set rights and access, update the package) would be helpful. I have kept that initial code that Jeanette sent to us that is the basic workflow in my Slack workspace and I think it would be helpful to have that in the training manual to read through and digest the steps.