Skip to content

Commit

Permalink
update links in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JBGruber committed Mar 5, 2024
1 parent 2449838 commit 4e9f550
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 40 deletions.
4 changes: 2 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ You can help by creating an [issue](https://github.com/JBGruber/atrrr/issues/new

If you are a developer, we are happy to accept pull requests.
It should be fairly straightforward, as all endpoints are already covered by automatically generated function.
For example, the endpoint [app.bsky.actor.getProfiles](https://atproto.com/lexicons/app-bsky) is accessible via `atrrr:::app_bsky_actor_get_profiles()`.
For example, the endpoint [app.bsky.actor.getProfiles](https://docs.bsky.app/docs/api/app-bsky-actor-get-profiles) is accessible via `atrrr:::app_bsky_actor_get_profiles()`.
The function `get_user_info()` is just a thin wrapper around that and calls an optional parsing function:

```
Expand All @@ -140,5 +140,5 @@ get_user_info <- function(actor,
return(res)
}
```
If you find an endpoint at <https://atproto.com/lexicons/com-atproto> or <https://atproto.com/lexicons/app-bsky> that interests you, you can write a similar wrapper and contribute it to the package (or build something new on top of it).
If you find an endpoint at <https://docs.bsky.app/docs/category/http-reference> that interests you, you can write a similar wrapper and contribute it to the package (or build something new on top of it).
But please open an [issue](https://github.com/JBGruber/atrrr/issues) first, so we don't do duplicated work.
84 changes: 46 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
# atrrr <img src="man/figures/logo.png" align="right" height="120">

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/atrrr)](https://CRAN.R-project.org/package=atrrr)

[![CRAN
status](https://www.r-pkg.org/badges/version/atrrr)](https://CRAN.R-project.org/package=atrrr)
[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![R-CMD-check](https://github.com/JBGruber/atrrr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/JBGruber/atrrr/actions/workflows/R-CMD-check.yaml)
Expand Down Expand Up @@ -83,23 +85,26 @@ option which results in a (more) tidy tibble.
get_skeets_authored_by(actor = "benguinaudeau.bsky.social", parse = TRUE) |>
dplyr::glimpse()
#> Rows: 25
#> Columns: 16
#> $ uri <chr> "at://did:plc:vuvsifrusnjsys7mhkpk662u/app.bsky.feed.pos…
#> $ cid <chr> "bafyreiegp7mni5p3njrgd52wl62jwjtbdxlms2ogzxaaod775tc6ri
#> $ author_handle <chr> "benguinaudeau.bsky.social", "benguinaudeau.bsky.social"…
#> $ author_name <chr> "Benjamin Guinaudeau", "Benjamin Guinaudeau", "David For
#> $ text <chr> "Genuinely opening a colleague's script to smoothly tran
#> $ author_data <list> ["did:plc:vuvsifrusnjsys7mhkpk662u", "benguinaudeau.bsk
#> $ post_data <list> ["Genuinely opening a colleague's script to smoothly tr
#> Columns: 19
#> $ uri <chr> "at://did:plc:3ryku2cbgpazorytvt6lt273/app.bsky.feed.pos…
#> $ cid <chr> "bafyreiabtdobd6w4scrbpqkvpgvdwidmdo7gyj6vvvcayol2drjalw
#> $ author_handle <chr> "beamagistro.bsky.social", "jbgruber.bsky.social", "jbgr
#> $ author_name <chr> "Beatrice Magistro", "Johannes B. Gruber", "Johannes B.
#> $ text <chr> "Excited to share my latest paper out at PSRM\n \"Attitu
#> $ author_data <list> ["did:plc:3ryku2cbgpazorytvt6lt273", "beamagistro.bsky.
#> $ post_data <list> ["app.bsky.feed.post", "2024-02-16T17:26:58.396Z", ["ap
#> $ embed_data <list> ["app.bsky.embed.images#view", [["https://cdn.bsky.app/…
#> $ reply_count <int> 0, 0, 4, 0, 1, 7, 0, 1, 0, 1, 0, 0, 0, 0, 1, 12, 0, 0, 1…
#> $ repost_count <int> 0, 0, 15, 2, 1, 366, 3, 1, 4, 28, 0, 0, 0, 0, 0, 290, 14…
#> $ like_count <int> 0, 1, 43, 6, 1, 498, 8, 3, 10, 34, 0, 0, 1, 4, 2, 455, 3…
#> $ indexed_at <dttm> 2024-01-03 16:49:08, 2024-01-03 16:46:52, 2023-12-23 22…
#> $ in_reply_to <chr> NA, "at://did:plc:eotrvt2wp6mqooxjf3bzklwa/app.bsky.feed…
#> $ in_reply_root <chr> NA, "at://did:plc:eotrvt2wp6mqooxjf3bzklwa/app.bsky.feed…
#> $ quotes <chr> NA, NA, NA, NA, "at://did:plc:3mcek454ldmpf2xr43auvhac/a…
#> $ is_reskeet <lgl> FALSE, FALSE, TRUE, TRUE, FALSE, TRUE, FALSE, TRUE, TRUE…
#> $ reply_count <int> 0, 1, 4, 0, 0, 4, 0, 1, 9, 0, 1, 0, 1, 0, 0, 0, 0, 1, 12…
#> $ repost_count <int> 6, 6, 8, 0, 0, 15, 2, 1, 440, 3, 1, 5, 28, 0, 0, 0, 0, 0…
#> $ like_count <int> 12, 20, 12, 0, 1, 43, 6, 1, 618, 7, 3, 10, 35, 0, 0, 1, …
#> $ indexed_at <dttm> 2024-02-16 17:26:58, 2024-01-10 15:23:18, 2024-01-04 16…
#> $ in_reply_to <chr> NA, NA, NA, NA, "at://did:plc:eotrvt2wp6mqooxjf3bzklwa/a…
#> $ in_reply_root <chr> NA, NA, NA, NA, "at://did:plc:eotrvt2wp6mqooxjf3bzklwa/a…
#> $ quotes <chr> NA, "at://did:plc:vgvueqvmbqgoyxtcdebqdcgb/app.bsky.feed…
#> $ tags <list> <NULL>, "rstats", "rstats", <NULL>, <NULL>, <NULL>, <NU…
#> $ mentions <list> <NULL>, <NULL>, <NULL>, <NULL>, <NULL>, <NULL>, <NULL>,…
#> $ links <list> <NULL>, <NULL>, <NULL>, <NULL>, <NULL>, <NULL>, <NULL>,…
#> $ is_reskeet <lgl> TRUE, TRUE, TRUE, FALSE, FALSE, TRUE, TRUE, FALSE, TRUE,…
```

## Analyzing Feeds on Blue Sky
Expand All @@ -123,23 +128,26 @@ rstat_feed <- feeds |>
# Extracting posts from this curated feed
rstat_posts <- get_feed(rstat_feed$uri, limit = 200) |>
dplyr::glimpse()
#> Rows: 95
#> Columns: 15
#> $ uri <chr> "at://did:plc:kizxn77jkp4p5vqzapbedvg2/app.bsky.feed.pos…
#> $ cid <chr> "bafyreiaks6igx35o4ygibk372rfjz3t5c7m5an4hmm5mlrnvgh7zo5
#> $ author_handle <chr> "pmaier1971.bsky.social", "pmaier1971.bsky.social", "urb
#> $ author_name <chr> "Philipp Maier", "Philipp Maier", "Rafael H. M. Pereira
#> $ text <chr> "Weekly Initial Claims (first-time applications for unem
#> $ author_data <list> ["did:plc:kizxn77jkp4p5vqzapbedvg2", "pmaier1971.bsky.s
#> $ post_data <list> ["Weekly Initial Claims (first-time applications for un
#> $ embed_data <list> ["app.bsky.embed.images#view", [["https://cdn.bsky.app/
#> $ reply_count <int> 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 4, 1, 1, 0, 2, 0, 0, 0,…
#> $ repost_count <int> 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 3, 0, 4, 0,…
#> $ like_count <int> 0, 0, 1, 0, 1, 1, 4, 2, 0, 0, 1, 19, 3, 0, 0, 10, 1, 12,
#> $ indexed_at <dttm> 2024-01-04 14:09:02, 2024-01-04 14:08:43, 2024-01-04 13…
#> Rows: 200
#> Columns: 18
#> $ uri <chr> "at://did:plc:vgvueqvmbqgoyxtcdebqdcgb/app.bsky.feed.pos…
#> $ cid <chr> "bafyreifard344uolete7a4vhogz3ja67k6bxumijc6fsuocapqutgt
#> $ author_handle <chr> "cranberriesfeed.bsky.social", "cranberriesfeed.bsky.soc
#> $ author_name <chr> "CRAN Package Updates Bot", "CRAN Package Updates Bot",
#> $ text <chr> "CRAN updates: minSNPs qris rgl SARP.compo #rstats\n", "
#> $ author_data <list> ["did:plc:vgvueqvmbqgoyxtcdebqdcgb", "cranberriesfeed.b
#> $ post_data <list> ["app.bsky.feed.post", "2024-03-05T09:02:16-06:00", [[[
#> $ embed_data <list> <NULL>, <NULL>, ["app.bsky.embed.record#view", ["app.bs
#> $ reply_count <int> 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 0, 0, 0, 0, 0,…
#> $ repost_count <int> 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 2, 0, 0, 0, 0, 0, 0,…
#> $ like_count <int> 0, 0, 4, 0, 0, 0, 0, 0, 0, 0, 0, 23, 3, 0, 0, 0, 0, 0, 0
#> $ indexed_at <dttm> 2024-03-05 15:02:16, 2024-03-05 14:02:11, 2024-03-05 13…
#> $ in_reply_to <chr> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, …
#> $ in_reply_root <chr> NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, NA, …
#> $ quotes <chr> NA, NA, NA, NA, NA, "at://did:plc:w4dzg6tdavlznotnfa2vth…
#> $ quotes <chr> NA, NA, "at://did:plc:iqrcfhxwrm5tyf7vqhnfgv6j/app.bsky.…
#> $ tags <list> "rstats", "rstats", "rstats", "rstats", "rstats", "rsta…
#> $ mentions <list> <NULL>, <NULL>, <NULL>, <NULL>, <NULL>, <NULL>, <NULL>,…
#> $ links <list> <NULL>, <NULL>, <NULL>, <NULL>, <NULL>, <NULL>, <NULL>,…
```

## Learn More?
Expand All @@ -157,8 +165,8 @@ new features or reporting bugs.
If you are a developer, we are happy to accept pull requests. It should
be fairly straightforward, as all endpoints are already covered by
automatically generated function. For example, the endpoint
[app.bsky.actor.getProfiles](https://atproto.com/lexicons/app-bsky) is
accessible via `atrrr:::app_bsky_actor_get_profiles()`. The function
[app.bsky.actor.getProfiles](https://docs.bsky.app/docs/api/app-bsky-actor-get-profiles)
is accessible via `atrrr:::app_bsky_actor_get_profiles()`. The function
`get_user_info()` is just a thin wrapper around that and calls an
optional parsing function:

Expand All @@ -182,10 +190,10 @@ optional parsing function:
return(res)
}

If you find an endpoint at <https://atproto.com/lexicons/com-atproto> or
<https://atproto.com/lexicons/app-bsky> that interests you, you can
write a similar wrapper and contribute it to the package (or build
something new on top of it). But please open an
If you find an endpoint at
<https://docs.bsky.app/docs/category/http-reference> that interests you,
you can write a similar wrapper and contribute it to the package (or
build something new on top of it). But please open an
[issue](https://github.com/JBGruber/atrrr/issues) first, so we don’t do
duplicated work.

Expand Down

0 comments on commit 4e9f550

Please sign in to comment.