Skip to content

📖 OpenRefine Tutorial #6308

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 39 commits into from
Sep 24, 2025
Merged

📖 OpenRefine Tutorial #6308

merged 39 commits into from
Sep 24, 2025

Conversation

dianichj
Copy link
Contributor

@dianichj dianichj commented Aug 18, 2025 •
edited by dadrasarmin
Loading

📖 OpenRefine Tutorial

This PR adds a new tutorial for Digital Humanities using OpenRefine.

  • Work in progress (draft).
  • Collaboration between Dani, Armin, and Diana.
  • Files included: tutorial.md, tutorial.bib, workflows, FAQs.

Next steps:

tutorial preparation:

  • Upload Data 2 Zenodo (Dani)
  • Checking the input file (Armin) - does Wolfgang's tool work or do we need to adapt the data manually to upload it from Galaxy in OR?
  • rename tsv file with cut out columns with links to upload it to zenodo -> add 2 tutorial
  • Can we automate the OpenRefine Tasks in the programming historian tutorial with the redo/function so we do not have to do it all again manually?
  • Can we add the OR tasks in a WF with Galaxy? Björn says likely not
  • Update Galaxy WF to make it completely automatable (Dani)
  • Check conditions for sharing the CCBYSA licence for the dataset (Dani)
  • Check if all steps for cleaning in the current Galaxy WF are needed when the dataset was cleaned before with OR (Current version relied on uncleaned data)
  • adapt WF if necessary
  • Upload WF to WF hub

tutorial:

We welcome comments and edits!

🤗:
@dadrasarmin
@Sch-Da

Sch-Da and others added 8 commits August 18, 2025 15:45
@Sch-Da
Update tutorial.bib
3f2c71b 
Adding reference tutorial from programming historian to the tutorial.bib
@Sch-Da
Update tutorial.md
02845e3 
Adding header with questions/objectives/contributers as a first draft
@Sch-Da
Update tutorial.md
549d1c1 
adding objectives and first paragraph for introduction
@Sch-Da
Rearrange tutorial.md
6abcd1d 
I rearranged the steps of the WF to be in the right order. This included the updates I made to the WF yesterday and is now on the latest update
@Sch-Da
Updating WF to latest version from Aug 18
bae4f3a
@Sch-Da
Update tutorial.md
e80df78 
Correcting citation in text
@Sch-Da
Update tutorial.md
1a0ebe4 
Marking tutorial parts which we should maybe let run as a WF instead
@dadrasarmin
Armin added OpenRefine section and some text and lots of screenshots.
574a8a2
Sch-Da

This comment was marked as resolved.

Sign in to view

dianichj and others added 14 commits August 25, 2025 10:59
@dianichj @Sch-Da
Update topics/digital-humanities/tutorials/open-refine-tutorial/tutor…
de0ab10 
…ial.md

Co-authored-by: Daniela Schneider <[email protected]>
@dianichj @Sch-Da
Update topics/digital-humanities/tutorials/open-refine-tutorial/tutor…
0ae3231 
…ial.md

Co-authored-by: Daniela Schneider <[email protected]>
@dianichj @Sch-Da
Update topics/digital-humanities/tutorials/open-refine-tutorial/tutor…
d608566 
…ial.md

Co-authored-by: Daniela Schneider <[email protected]>
@dianichj @Sch-Da
Update topics/digital-humanities/tutorials/open-refine-tutorial/tutor…
f65839b 
…ial.md

Co-authored-by: Daniela Schneider <[email protected]>
@dianichj @Sch-Da
Update topics/digital-humanities/tutorials/open-refine-tutorial/tutor…
e632a6b 
…ial.md

Co-authored-by: Daniela Schneider <[email protected]>
@dianichj @Sch-Da
Update topics/digital-humanities/tutorials/open-refine-tutorial/tutor…
0f360f2 
…ial.md

Co-authored-by: Daniela Schneider <[email protected]>
@dianichj
Update tutorial.md - Fixed Hands-on Boxes
29b5ae7
@Sch-Da
Update tutorial.md
a97fdc8 
Adding a coupe of lines for trouble shooting when opening and loading openrefine
@Sch-Da
Update tutorial.md
9c9ed50 
Adding detail on when to close open refine
@dianichj
Merge branch 'main' into openrefine-tutorial
f29a853
@dianichj
Update tutorial.md
c2b2cc6
@dianichj
Update tutorial.md
5fe33f1
@dianichj
Update tutorial.md - Fixing boxes and nesting
2d98ff1
@shiltemann
Merge branch 'main' into openrefine-tutorial
9cf1446
Sch-Da and others added 7 commits September 10, 2025 09:05
@Sch-Da
Update tutorial.md
2985094 
Adding Zenodo link
removing currently not needed steps from the auto-generated tutorial
reorganising with different headline levels
typo removal
@dadrasarmin
Updated the contributions section to render it correctly.
aa052cb
@dadrasarmin
Added data-library.yaml file for data library access.
67428b2
@Sch-Da
Update tutorial.md
a904e2f 
Adapt explanation text for OR
@Sch-Da
Update tutorial.md
0d9934a 
Updating WF explanation
@Sch-Da
Add files via upload
0e0d654
@dadrasarmin
Added workflowhub import description, added a final word cloud, added…
1564d7b 
… nfdi4culture to Dani profile.
@dadrasarmin
Copy link
Collaborator

@shiltemann Dani went to vacation for multiple days. I think she needs the tutorial when she is back at the end of September. Based on my understanding, the tutorial is ready for your final review. There is not linting error as well as far as I see. Tutorial reads well.

I suggest that we merge this, if you agree. In case of urgent need for an update, I can provide support for a quick fix later.

@shiltemann
Copy link
Member

shiltemann commented Sep 19, 2025 •
edited
Loading

@dadrasarmin thanks a lot for letting me know! I will take it out of GitHub draft mode ("Ready for review" button) so that some more tests will run, and then do a review 👍

@shiltemann shiltemann marked this pull request as ready for review September 19, 2025 09:58
@shiltemann shiltemann changed the title 📖 OpenRefine Tutorial (Work in Progress...) 🚧 📖 OpenRefine Tutorial Sep 19, 2025
shiltemann
shiltemann reviewed Sep 19, 2025
View reviewed changes
Copy link
Member

@shiltemann shiltemann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great @dianichj! Just a few very small remarks from me below.

@Sch-Da As topic maintainer, would you like to have a final look as well, and hit the approve button if you are happy with the content? :)

Thanks all!

topics/digital-humanities/tutorials/open-refine-tutorial/tutorial.md Outdated
>
> <p align="center">
> <img src="openrefine.png" alt="OpenRefine tool interface in Galaxy">
> </p>
Copy link
Member

@shiltemann shiltemann Sep 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can see why you added screenshots here, but now that there is a good intro to Galaxy tutorial in the DH topic, I would suggest removing the Galaxy screenshots, since the interface changes a lot and people might be confused if it doesnt look the same. And we can assume they are familiar with the Galaxy basics at this point.

So keep screenshots of OpenRefine, but any screenshots of only Galaxy, please consider if they can be removed

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is something Dani should decide. So, I do not integrate this comment until she is back.

dadrasarmin
dadrasarmin reviewed Sep 19, 2025
View reviewed changes
Copy link
Collaborator

@dadrasarmin dadrasarmin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did most of the changes requested by Saskia. Those that I left undone, in my view, are waiting for Dani's decisions.

topics/digital-humanities/tutorials/open-refine-tutorial/tutorial.md Outdated
>
> <p align="center">
> <img src="openrefine.png" alt="OpenRefine tool interface in Galaxy">
> </p>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is something Dani should decide. So, I do not integrate this comment until she is back.

@shiltemann shiltemann merged commit 16754af into galaxyproject:main Sep 24, 2025
3 checks passed
@Sch-Da Sch-Da deleted the openrefine-tutorial branch September 30, 2025 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dadrasarmin dadrasarmin dadrasarmin left review comments

@github-actions github-actions[bot] github-actions[bot] left review comments

@Sch-Da Sch-Da Sch-Da left review comments

@shiltemann shiltemann shiltemann approved these changes

Assignees
No one assigned
Labels
digital-humanities template-and-tools
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@dianichj @dadrasarmin @shiltemann @Sch-Da