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

Fix #162 #163

Merged
merged 1 commit into from
Jan 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ URL: https://gesistsa.github.io/rtoot/, https://github.com/gesistsa/rtoot/
BugReports: https://github.com/gesistsa/rtoot/issues
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.3.1
RoxygenNote: 7.3.2
Depends:
R (>= 3.6)
Imports:
Expand Down
2 changes: 1 addition & 1 deletion R/utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ print.rtoot_bearer <- function(x, ...) {
#' rtoot(endpoint = "api/v1/notifications", params = list(limit = 8))
#' rtoot(endpoint = "api/v1/followed_tags")
#' ## reimplement `get_timeline_public`
#' rtoot(endpoint = "api/v1/timelines/public", instance = "emacs.ch", local = TRUE, anonymous = TRUE)
#' rtoot(endpoint = "api/v1/timelines/public", instance = "mastodon.social", local = TRUE, anonymous = TRUE)
#' }
rtoot <- function(endpoint, ..., params = list(), token = NULL, instance = NULL,
anonymous = FALSE) {
Expand Down
2 changes: 1 addition & 1 deletion man/rtoot.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

59 changes: 34 additions & 25 deletions methodshub.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ the following URL: <https://docs.joinmastodon.org/>.
## Science Usecase(s)

<!-- - Include usecases from social sciences that would make this method applicable in a certain scenario. -->

<!-- The use cases or research questions mentioned should arise from the latest social science literature cited in the description. -->

Although not using this package, the data from the Mastodon API has been
Expand All @@ -42,19 +43,23 @@ install.packages("rtoot")
```

<!-- ## Hardware Requirements (Optional) -->

<!-- - The hardware requirements may be needed in specific cases when a method is known to require more memory/compute power. -->

<!-- - The method need to be executed on a specific architecture (GPUs, Hadoop cluster etc.) -->

## Input Data

<!-- - The input data has to be a Digital Behavioral Data (DBD) Dataset -->

<!-- - You can provide link to a public DBD dataset. GESIS DBD datasets (https://www.gesis.org/en/institute/digital-behavioral-data) -->

No applicable.

## Sample Input and Output Data

<!-- - Show how the input data looks like through few sample instances -->

<!-- - Providing a sample output on the sample input to help cross check -->

As a data collection software, this tool does not have any “sample
Expand All @@ -67,6 +72,7 @@ from the Mastodon API.
## How to Use

<!-- - Providing HowTos on the method for different types of usages -->

<!-- - Describe how the method should be used, including installation, configuration, and any specific instructions for users. -->

Please refer to the [“Introduction to
Expand All @@ -81,39 +87,39 @@ on

However, it is also possible to use some of functions with
authentication. For example, it is possible to obtain the public
timeline of a Mastodon instance, e.g. emacs.ch.
timeline of a Mastodon instance, e.g. sciences.social.

``` r
library(rtoot)
get_timeline_public(instance = "emacs.ch")
get_timeline_public(instance = "sciences.social")
```

# A tibble: 20 × 29
id uri created_at content visibility sensitive spoiler_text
<chr> <chr> <dttm> <chr> <chr> <lgl> <chr>
1 11264208… http… 2024-06-19 07:23:24 "<p>Wh… public FALSE ""
2 11264208… http… 2024-06-19 07:23:19 "<p>L'… public FALSE ""
3 11264208… http… 2024-06-19 07:23:05 "<p><a… public FALSE ""
4 11264208… http… 2024-06-19 07:23:04 "<p>Wo… public FALSE ""
5 11264208… http… 2024-06-19 07:22:59 "<p>Ja… public FALSE ""
6 11264208… http… 2024-06-19 07:22:54 "<p>Al… public FALSE ""
7 11264208… http… 2024-06-19 07:04:28 "<p>Ru… public FALSE ""
8 11264208… http… 2024-06-19 07:22:35 "<p>Re… public FALSE ""
9 11264208… http… 2024-06-19 07:22:27 "<p>🎶… public FALSE ""
10 11264208… http… 2024-06-19 07:22:23 "<p>Ne… public FALSE ""
11 11264208… http… 2024-06-19 07:22:19 "<p>I … public FALSE ""
12 11264207… http… 2024-06-19 07:22:11 "<p><a… public FALSE ""
13 11264207… http… 2024-06-19 07:22:08 "So, W… public FALSE ""
14 11264207… http… 2024-06-19 07:22:02 "<p>Gi… public FALSE ""
15 11264207… http… 2024-06-19 07:22:00 "<p>\"… public FALSE ""
16 11264207… http… 2024-06-19 07:21:58 "<p>Fe… public FALSE ""
17 11264207… http… 2024-06-19 07:21:48 "Wow i… public FALSE ""
18 11264207… http… 2024-06-19 07:21:49 "<p>Sy… public FALSE ""
19 11264207… http… 2024-06-19 07:21:29 "<a cl… public FALSE ""
20 11264207… http… 2024-06-19 07:21:45 "<p><a… public FALSE ""
1 11383222… http… 2025-01-15 11:35:50 "<p>To… public FALSE ""
2 11383222… http… 2025-01-15 11:51:55 "<p>“O… public FALSE ""
3 11383222… http… 2025-01-15 11:51:47 "<p><a… public FALSE ""
4 11383222… http… 2025-01-15 11:51:38 "<p>de… public FALSE ""
5 11383222… http… 2025-01-15 11:34:33 "<p>In… public FALSE ""
6 11383222… http… 2025-01-15 11:51:20 "<p>On… public FALSE ""
7 11383222… http… 2025-01-15 11:51:32 "<p>To… public FALSE ""
8 11383222… http… 2025-01-15 11:51:29 "<p>Ge… public FALSE ""
9 11383222… http… 2025-01-15 11:36:25 "<p>Ma… public FALSE ""
10 11383222… http… 2025-01-15 06:14:00 "<p>Bi… public FALSE ""
11 11383222… http… 2025-01-15 11:51:16 "<p>De… public FALSE ""
12 11383222… http… 2025-01-15 11:51:20 "<p>Ju… public FALSE ""
13 11383222… http… 2025-01-15 05:52:00 "<p>Al… public FALSE ""
14 11383222… http… 2025-01-15 11:51:12 "<p>St… public FALSE ""
15 11383222… http… 2025-01-15 11:51:13 "<p>Sp… public FALSE ""
16 11383222… http… 2025-01-15 11:51:10 "<p>Hi… public FALSE ""
17 11383222… http… 2025-01-15 11:51:10 "<p>El… public FALSE ""
18 11383222… http… 2025-01-15 11:51:08 "<p><a… public FALSE ""
19 11383222… http… 2025-01-15 11:51:07 "<p>Ho… public FALSE ""
20 11383222… http… 2025-01-15 11:51:05 "<p>Th… public FALSE ""
# ℹ 22 more variables: reblogs_count <int>, favourites_count <int>,
# replies_count <int>, url <chr>, in_reply_to_id <chr>,
# in_reply_to_account_id <chr>, language <chr>, text <lgl>,
# replies_count <int>, url <chr>, in_reply_to_id <lgl>,
# in_reply_to_account_id <lgl>, language <chr>, text <lgl>,
# application <I<list>>, poll <I<list>>, card <I<list>>, account <list>,
# reblog <I<list>>, media_attachments <I<list>>, mentions <I<list>>,
# tags <I<list>>, emojis <I<list>>, favourited <lgl>, reblogged <lgl>,
Expand All @@ -133,9 +139,12 @@ Issue Tracker: <https://github.com/gesistsa/rtoot/issues>
1. Schoch, D., & Chan, C. H. (2023). Software presentation: Rtoot:
Collecting and analyzing Mastodon data. Mobile Media &
Communication, 11(3), 575-578.
https://doi.org/10.1177/20501579231176678
<https://doi.org/10.1177/20501579231176678>

<!-- ## Acknowledgements -->

<!-- - Acknowledgements if any -->

<!-- ## Disclaimer -->

<!-- - Add any disclaimers, legal notices, or usage restrictions for the method, if necessary. -->
6 changes: 3 additions & 3 deletions methodshub.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,11 @@ Please refer to the ["Introduction to rtoot"](https://gesistsa.github.io/rtoot/a

In general, one should first conduct the authentication to obtain an access token. This can be done with the provided function `auth_setup()`. For more information, please refer to the documentation on [authentication](https://gesistsa.github.io/rtoot/articles/auth.html).

However, it is also possible to use some of functions with authentication. For example, it is possible to obtain the public timeline of a Mastodon instance, e.g. emacs.ch.
However, it is also possible to use some of functions with authentication. For example, it is possible to obtain the public timeline of a Mastodon instance, e.g. sciences.social.

```{r}
library(rtoot)
get_timeline_public(instance = "emacs.ch")
get_timeline_public(instance = "sciences.social")
```

Other functions, e.g. `get_timeline_hashtag()`, `get_account_statuses()` require authentication.
Expand All @@ -86,7 +86,7 @@ Issue Tracker: [https://github.com/gesistsa/rtoot/issues](https://github.com/ges

## Publication

1. Schoch, D., & Chan, C. H. (2023). Software presentation: Rtoot: Collecting and analyzing Mastodon data. Mobile Media & Communication, 11(3), 575-578. https://doi.org/10.1177/20501579231176678
1. Schoch, D., & Chan, C. H. (2023). Software presentation: Rtoot: Collecting and analyzing Mastodon data. Mobile Media & Communication, 11(3), 575-578. <https://doi.org/10.1177/20501579231176678>

<!-- ## Acknowledgements -->
<!-- - Acknowledgements if any -->
Expand Down
Loading