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

Twarc Tutorial #558

Merged
merged 22 commits into from
Dec 20, 2022
Merged

Twarc Tutorial #558

merged 22 commits into from
Dec 20, 2022

Conversation

SamHames
Copy link
Contributor

@SamHames SamHames commented Oct 20, 2021

I think this is most of flow and content that I think should be included.

Outstanding items are (at least!):

  • Make the research question/approach more concrete
  • Write what is an API section
  • Write introduction the Twitter API section
  • Is the pandas section a good idea, and if it is, should we run it interactively or as a script. Obviously this should link to other lessons focusing on jupyter notebooks and other interactive analysis, but I'd prefer to avoid that in this base lesson.
  • Link to more resources - what would be good?
  • Does this all make sense?
  • Make screenshots in windows of all the parts that need screenshots
  • Spelling, grammar, and editing pass

@edsu
Copy link
Member

edsu commented Jan 20, 2022

This is looking good!

@SamHames SamHames force-pushed the tutorial branch 3 times, most recently from c1928c3 to 1859476 Compare February 9, 2022 06:07
Copy link
Contributor

@boyd-nguyen boyd-nguyen left a comment

Choose a reason for hiding this comment

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

Hi Sam, thanks for sharing the tutorial. I think it covers everything with enough details and explanations! Personally, one thing I would suggest is the order of some sections, outlined below:

  • Motivating example (kept as is)
  • Introduction to twarc and Twitter API
    • Introduction to twarc (moved from below)
    • Twitter API (brief explanation of what an API is, what "endpoint" means + what can you do with the Twitter API)
  • Ethical considerations when using social media data
    • Ethical use of public communication data
    • Copyright
    • Twitter's term of service
  • Setup (kept as is with the exception of Introduction to twarc which is moved up to the section above)
  • "Introduction to Twitter search and counts" and other sections are kept as is

My rationale behind this structure is that it separates dev-related and ethics-related subjects into 2 sections. The Intro to twarc and Twitter API also provides the background knowledge needed to understand the content below, so that everything from Setup onwards will focus on using the tool. What are your thoughts?

There are minor letter-casing and editorial points that I came across, but I think it makes sense to leave them til the end once the high-level structure and everything else has been finalised?

@SamHames
Copy link
Contributor Author

I've incorporated those suggestions, thanks!

@betsybookwyrm
Copy link
Contributor

I've added a brief what-is-an-API section, but I struggled finding a good resource to link to for the target audience - researchers who want to understand what's going on but most likely don't need to do any coding. If anyone has a good link up their sleeve please share!

@betsybookwyrm
Copy link
Contributor

I think the main things that are left to do are:

  • take and put in the screenshots Sam has described
  • proofread and get at least a semi-outsider to read through and see if it seems to make sense

SamHames and others added 18 commits October 10, 2022 14:59
Add `pip install -e .` step to readme instructions for running local
documentation server
Adds a brief overview of what an API is to the tutorial.
plus a tweak to the pandas section.

This was written in collaboration with @Quiet27 and @boyd-nguyen
Fixes an error when running `mkdocs serve` for recent versions of
dependencies. See mkdocstrings/mkdocstrings#436
Adds a brief paragraph about v1.1 and v2.
@betsybookwyrm
Copy link
Contributor

Thanks @boyd-nguyen and @mctakahashi for the screenshots, and Sam for merging :)

Copy link
Contributor

@Quiet27 Quiet27 left a comment

Choose a reason for hiding this comment

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

Awesome, hurray for the twarc tutorial! I did a content/proof-read review 😸

docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
LGTM!

Co-authored-by: Alice <51159066+Quiet27@users.noreply.github.com>
@igorbrigadir
Copy link
Contributor

Awesome! This looks pretty good to me!

@betsybookwyrm betsybookwyrm marked this pull request as ready for review December 19, 2022 03:40
@betsybookwyrm
Copy link
Contributor

We're all happy with this as a first pass! Thanks for having a look Igor. @SamHames did you want to have a final check?

@SamHames SamHames merged commit 57c7cb2 into main Dec 20, 2022
@igorbrigadir igorbrigadir deleted the tutorial branch December 20, 2022 17:03
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

Successfully merging this pull request may close these issues.

6 participants