data-lessons/library-data-intro-deprecated

Data intro for librarians NOW MOVED > https://github.com/LibraryCarpentry/lc-data-intro

This material has now been moved to the Library Carpentry organisation.

Find it here: https://github.com/LibraryCarpentry/lc-data-intro

Library Carpentry

The Library Carpentry module 'Data Intro for Librarians' is maintained by Carmi Cronje and James Baker.

Background

Library Carpentry is a software skills training programme aimed at library and information professions. It builds on the work of Software Carpentry and Data Carpentry.

Library Carpentry is in the commons and for the commons. It is not tied to any institution of person. For more information on Library Carpentry, see our website librarycarpentry.github.io.

Contribution

There are many ways of contributing to Library Carpentry:

• Join our Gitter discussion forum.
• Follow updates on Twitter.
• Make a suggestion or correct an error by raising an Issue.

Code of Conduct

All participants should agree to abide by the Software Carpentry Code of Conduct.

Authors

Library Carpentry is authored and maintained by the community.

Citation

Please cite as:

Library Carpentry. Data Intro for Librarians. June 2016. http://data-lessons.github.io/library-data-intro/.

library-data-intro-deprecated's Issues

Proposed learning objective

After completing this lessons, you can:

• explain terms, phrases, or ideas around code or software development that you've come across and perhaps feel you should know better
• explain and use some best practices and generic skills in using computation
• do searches using regular expressions

Lesson review

@ndalyrose is doing a review of the lesson so expect a pull request some time today or tomorrow.

Typo's in text

In the first paragraph of the introduction the word 'worked' is used twice in the phrase about James Baker.

In the paragraph under Foundation in the last phrase the word nest is used where it should be the word next.

Settings

So I tried to add @ccronje as an admin for this repo and in my fiddling about can no longer see the 'settings' button. Can someone fix please? (cc @mkuzak @weaverbel) Sorry :(

Maintaining the lesson

@ccronje has volunteered as a maintainer

Giving Greg contributor access

@ccronje Remind me, who has the power to add @gvwilson as a contributor to this repo? (so he can assign himself pull requests et cetera) @tracykteal as owner? Greg needs the ability to do this across all our modules.

Create library-overview repo & site with links to all lessons

These are great resources! I would love to be able to send my library colleagues to a single (non-README) site with all the lessons listed. If such a resource exists already, where is it? If it doesn't exist, could a very small repo be established with links to each of the lessons? The links in the README work fine for those comfortable with GitHub, but a novice-friendly overview page, presented like the index.html pages for each lesson would be easier for many folks to navigate (If someone on the data-lessons project wants to create the repo, I can take a first pass at the index.html).

Improve lesson objectives

Improve the lesson/learning objectives in the Overview box at the top of each episode e.g. https://data-lessons.github.io/library-data-intro/01-introduction/, https://data-lessons.github.io/library-data-intro/02-jargon-busting/.

Please see Writing Learning Objectives http://swcarpentry.github.io/instructor-training/19-lessons/.

Sprint tasks for the data intro lesson

@ccronje Pinging for a quick chat on general tasks for this lesson during the sprint.

I think I will revise http://data-lessons.github.io/library-data-intro/02-jargon-busting/ based on what I did in Pittsburgh. @ndalyrose and I will work on more regex #27. Anything else?

Regex explanations

Hi @drjwbaker
I am a bit of a regex dunce and find it hard to teach the examples in the slides as I am not sure if the examples given are meant to be good examples or bad ones. I have tried to deconstruct them in the class using rexper, regex101 etc to help people understand what the different syntaxes mean but I am sure I have sown more confusion than clarity ;-(. if you upload the slides again, can you please provide some notes of what all the different 'Organise' slides mean? That would be great. Cheers Belinda

Feedback, tips, lessons learned

Seeking feedback from those who have taught this lesson - please share your thoughts e.g. what worked, what didn't work, what could be improved.

Some of this feedback will be included in the lesson's Instructor Notes as tips, or new issues to improve the lesson.

Make gh-pages default branch

This has been done in the other LC repos.

Revise learning outcomes

Revise learning outcomes for lesson to fit Bloom's taxonomy at http://swcarpentry.github.io/instructor-training/19-lessons/

Contact

Contact details here http://data-lessons.github.io/library-data-intro/ go to [email protected] and on http://data-lessons.github.io/library-openrefine/ to [email protected]

We need to relieve Greg of more email and standardise this across the repos. @cmacdonell, given that your name is on one, was the a deliberate change and are you happy to take the email? Perhaps the lesson maintainer can take the traffic?

Suggestion for 04-regular-expressions.md header

---
title: "Regular Expressions"
teaching: 20
exercises: 25
questions:
- "What are regular expressions? How do they relate to computational thinking?"
objectives:
- "Understand how computational approaches enable pattern matching"
- "Use regular expressions in searches"
keypoints:
- "A regular expression is a sequence of characters that defines a pattern for searching and matching"
- "Most computational software has regular expression functionality built in"
- "Using consistent data organisation and naming conventions enables you to leverage regular expression searches"

---

This header is a suggestion for discussion. Title and Questions also appear on http://data-lessons.github.io/library-data-intro/ - see http://data-lessons.github.io/library-openrefine/ for example. Key Points are located in each episode at end of page.

QA Regex quiz

It would be great if someone with regex knowledge could Q&A the new regex quiz at https://github.com/data-lessons/library-data-intro/blob/master/lesson-materials/LibCarp-introtodata-handout.md#multiple-choice-quiz (answers at https://github.com/data-lessons/library-data-intro/blob/master/lesson-materials/LibCarp-introtodata-answers.md) and if someone else whose less regex confident could take the quiz, report back on their score, and rate the quiz in terms of difficulty. It could well benefit from additions, more questions at different levels, et cetera.

If you pick this up, make yourself known and someone can assign the issue to you.

Missing slides

@drjwbaker It looks like we're missing your slide deck since the template updates.

Figure out a workflow for getting DOIs for regular LibCarp releases {META}

I like the idea of creating (say) an annual release of Library Carpentry, with a DOI, et cetera. And I've used the Zenodo-Github link to do this with projects in the past. Looking at my Zenodo account, I making a release for each lesson so this is possible, though I'd rather do a big bundle per Programming Historian https://zenodo.org/record/30935#.V8VN9I78_6h. Does anyone have any thoughts on this? What I guess I'm proposing is that we do a "version x" release of all the Github repos combined (in some way..) on a semi-regular basis. This will need to be managed to ensure: 1) it is done at the regular intervals 2) everyone involved in credited correctly 3) the metadata is put somewhere public for reference.

cc @jt14den

Add authors to AUTHORS file

We now have a workflow for releasing citable versions of our lessons (with DOIs) every 6 months via Zenodo. This makes our more discoverable and sustainable and ensures that everyone involved gets the credit they deserve. For more on this work see data-lessons/librarycarpentry#5

In order to make this happen we need to make one crucial change: all AUTHORS files need to change so that they list names of contributors in the following format:

James Allen
James Baker
Piotr Banaszkiewicz
Erin Becker

@jt14den will run a script that that strips names from lesson logs and edit AUTHORS across all Library Carpentry repos.

When this is actioned (hopefully, soon!), lesson maintainers are asked to eyeball the AUTHORS file to see if anyone obvious is missing (for example, people who contributed to discussions but didn't edit any lessons). Note: template developers are credited in this process; this is in line with Software Carpentry best practice.

In the future, lesson maintainers are encouraged to ensure that those who contribute to lessons are added manually to AUTHORS files (encourage contributors to do it so they see where and how we give credit!)

Suggestion for 03-foundations.md header

---
title: "Foundations"
teaching: 30
exercises: 15
questions:
- "What are the skills and practice that define computational thinking?"
objectives:
- "Understand what is meant by computational approaches"
- "Identify and use best practice in data structures"
keypoints:
- "Data structures should be consistent and predictable"
- "Consider using semantic elements or data identifiers to data directories"
- "Fit and adapt your data structure to your work"
- "Apply naming conventions to directories and file names to identify them, to create associations between data elements, and to assist with the long term readability and comprehension of your data structures"

---

This header is a suggestion for discussion. Title and Questions also appear on http://data-lessons.github.io/library-data-intro/ - see http://data-lessons.github.io/library-openrefine/ for example. Key Points are located in each episode at end of page.

Suggestion for 02-jargon-busting.md header

---
title: "Jargon Busting"
teaching: 15
exercises: 30
questions:
- "What are common concepts and terms around code and software development?"
objectives:
- "Understand terms, phrases, and concepts in software development and data science"
- "Understand the terms and concepts that apply to Library Carpentry"
- "Get to know attendees, find confidence level, manage expectations"
keypoints:
- "Facilitating peer to peer teaching and learning"
- "Library Carpentry in the context of data science"

---

This header is a suggestion for discussion. Title and Questions also appear on http://data-lessons.github.io/library-data-intro/ - see http://data-lessons.github.io/library-openrefine/ for example. Key Points are located in each episode at end of page.

proposed _episodes

Split LibCarp-introdata.md into:

01-introduction.md (~15min)
02-jargon-busting.md (45min)
03-foundations.md (45min)
04-regular-expressions.md (45min)

Rename LibCarp-introdata-handout.md to:

05-handout-questions.md

Rename LibCarp-introdata.answers.md to:

06-handout-answers.md

Or should we combine 05 & 06? (it could be considered a 45min episode)

The slide deck files (LibCarp-introdata-deck.pdf/odp) are not episodes so where should they be placed in the new structure? Or would it be better to create an "Instructors' Guide" based on this content? Note: LibCarp-introdata.md references the slide deck with "SLIDE" throughout but this is easy enough to change.

@weaverbel let me know and I'll go ahead with the changes

Exercises in Foundations Episode

The episode Foundations indicates 15 minutes for exercises, but no exercises are included. Is there a suggested exercise? What have those who have taught this lesson used?

delimiters in colour example

The colour insensitive example /regex/i tripped me up a little. I wonder if it's worth adding a note earlier that delimiters are /regex/ which is case sensitive (as can be seen in https://regex101.com/ - but have been removed from examples for easier reading.

Suggestion for 01-introduction.md header

---
title: "Introduction to Data"
teaching: 15
exercises: 0
questions:
- "What is Library Carpentry?"
objectives:
- "Introduce Library Carpentry"
- "Explain the objectives of the program"
- "Explain the methods and tools covered in the program"
- "Explain peer to peer teaching and learning methodology"
keypoints:
- "Think about your skill level and who you can help around you"
- "Learn by example, learn by doing, learn by coding"
- "Place a sticky note on your laptop to flag when you need help"
- "Library Carpentry format: four modules, 3 hours per module"
- "Topics covered: introduction to data, controlling data using the command line, versioning data, and cleaning data"
- "Tools covered: regular expressions, Unix Shell, Git, OpenRefine"

---

This header is a suggestion for discussion. Title and Questions also appear on http://data-lessons.github.io/library-data-intro/ - see http://data-lessons.github.io/library-openrefine/ for example. Key Points are located in each episode at end of page.

Answer sheet and hand-out are mentioned but there's no explanation how and where to find them

Setup page correction

Content of set-up page contains the description on lesson development, not the set-up for the data intro lesson. Please update.

add smaller regex excercises sooner and introduce new regex in smaller chunks

Add link to Library Carpentry on lesson pages

In looking over the data intro lesson, I could not find a link to the home page of Library Carpentry (http://librarycarpentry.github.io/). Perhaps at the bottom of lesson pages, where copyright information is found, the link could be to librarycarpentry.github.io (most lessons appear to have self-referential links [i.e. Library Carpentry links to whatever the current page is]).

License

@weaverbel The license James applied is CC BY-SA, which requires us to apply the same license. Data Carpentry uses CC BY. Will this be an issue with DC in terms of consistency?

JOINS in episode 4

Even though JOINS are introduced first in episode 6 the novice shall work with them at the end of episode 4. This can be confusing as it is not explanatory in the upcoming episode as well.

Incorporate real Library examples in text & interactive exercise

Reviewed this lesson today with some colleagues and thinking it could benefit from more concrete/worked out Library examples of regex in action, as well as an interactive exercise option (ie, provide a text file with typical library-style data such as messy catalogue records and guide participants through using various regular expressions to query them).

Comments for instructor are scattered around within the lesson itself

This happens across different lessons