added `fields` to `find_groups()` to retrieve optional fields from M… #48

benubah · 2019-05-31T08:42:43Z

I added fields to find_groups() to retrieve optional fields from Meetup API

The find/groups method (https://www.meetup.com/meetup_api/docs/find/groups/ ) within the Meetup API has several optional fields that are not returned by default.
They will be returned when you pass them to the fields attribute as part of your API query. This functionality is now provided within meetupr. In meetupr, after the query, these fields can then be retrieved from the resource tibble attribute already defined in find_groups().

…etup API find/groups method within the Meetup API has several optional fields that are not returned by default. They will be returned when you pass them to the `fields` attribute as part of your API query. This functionality is now provided within meetupr. In meetupr, after the query, these fields can then be retrieved from the `resource` tibble attribute already defined in find_groups().

…e `event_hosts`

benubah · 2019-05-31T14:19:31Z

fields has also been added to get_events() for the same purpose of returning optional fields that are not returned by default

ledell · 2019-06-06T05:14:27Z

@benubah This looks like a nice usability feature. I think if we are going to add something like this, it would make sense to add it to all our functions... what do you think, @LucyMcGowan?

It also may make sense to call it something like extra_fields or additional_fields to emphasize that these are columns that are in addition to the default ones? I am open to ideas.

LucyMcGowan · 2019-06-06T19:39:01Z

This looks good! I am torn on whether it should be called extra_fields or additional_fields versus fields - the way you currently have it matches the meetup API docs since they call it fields, but the way @ledell proposes is a bit clearer (to me) - I was initially confused and thought you'd need to list all desired fields in that parameter, not just the additional ones

ledell · 2019-06-06T19:59:03Z

@benubah @LucyMcGowan I am noticing now that this is an actual parameter in the API (I thought it was just made up parameter for extra usability), so I understand now why it was named fields (to match API) even though it's somewhat of a misnomer. @benubah Are there any other API methods that we already implement that have a fields parameter other than get_events() and find_groups()? If so, we can update them all at once.

It's a bit confusing because there's no way for the user to know in advance what extra fields they want unless they carefully read the API docs... would it make sense to hard-code the extra field options so the user is not digging into API docs to use the parameter effectively? e.g. fields = c("event_hosts", "featured", ...)

Trying out an example (without using fields), this is what I see:

urlname <- "rladies-nashville"
past_meetings <- get_events(urlname = urlname, event_status = "past", api_key = api_key)

Here's what we return in our tibble:

> names(past_meetings)
 [1] "id"              "name"            "created"         "status"          "time"            "local_date"      "local_time"     
 [8] "waitlist_count"  "yes_rsvp_count"  "venue_id"        "venue_name"      "venue_lat"       "venue_lon"       "venue_address_1"
[15] "venue_city"      "venue_state"     "venue_zip"       "venue_country"   "description"     "link"            "resource"

And here are the remaining fields available by default in the resource list (raw data):

> names(past_meetings$resource[[1]])
 [1] "created"                "duration"               "id"                     "name"                   "date_in_series_pattern"
 [6] "status"                 "time"                   "local_date"             "local_time"             "updated"               
[11] "utc_offset"             "waitlist_count"         "yes_rsvp_count"         "venue"                  "group"                 
[16] "link"                   "description"            "how_to_find_us"         "visibility"             "pro_is_email_shared"

LucyMcGowan · 2019-06-06T20:02:41Z

One option could be to include a link to the API docs directly with a list of potential fields (if such a thing exists) in the docs about this new parameter

ledell · 2019-06-06T20:25:37Z

@benubah Here's what I suggest -- let's leave fields defaulting to NULL, but in the fields parameter description, let's hardcode the list of options so the user does not have to leave the R terminal and go to the web to look them up.

ledell · 2019-06-06T20:38:34Z

R/get_events.R

@@ -9,7 +9,7 @@
 #'  * proposed
 #'  * suggested
 #'  * upcoming
-#'
+#' @param fields Character or characters separated by comma (e.g "event_hosts" or "event_hosts, past_event_count_inclusive").


I tried passing "event_hosts, past_event_count_inclusive" and it did not work... I don't see "past_event_count_inclusive" on the list of additional fields: https://www.meetup.com/meetup_api/docs/2/events/

Thank you for reviewing this. The additional fields are stored in resource - last attribute in the tibble, so the following works for me:

urlname <- "rladies-ames"
#get past meetings of a single group
past_meetings <- get_events(urlname = urlname, event_status = "past", fields = "event_hosts, past_event_count_inclusive", api_key = api_key)
# get events hosts of single past meeting
single_event <- past_meetings$resource[[1]]$event_hosts

These additional fields are not available in v2 of the meetup API. You can see them in v3 here: https://www.meetup.com/meetup_api/docs/:urlname/events/#list

The past_event_count_inclusive field is not returned:

> names(past_meetings$resource[[1]]) [1] "created" "duration" "id" [4] "name" "date_in_series_pattern" "status" [7] "time" "local_date" "local_time" [10] "rsvp_close_offset" "updated" "utc_offset" [13] "waitlist_count" "yes_rsvp_count" "venue" [16] "group" "link" "description" [19] "how_to_find_us" "visibility" "pro_is_email_shared" [22] "event_hosts" > past_meetings$resource[[1]]$past_event_count_inclusive NULL

Are you able to see it in your results? I see that it's listed in v3 docs but not v2 so I wonder if that's causing some issue.

No, I don't see past_event_count_inclusive. This looks like a problem from within the API itself, because, I tried group_past_event_count and it returned a value under group list in resource.

past_meetings <- get_events(urlname = urlname, event_status = "past", fields = "event_hosts, group_past_event_count", api_key = api_key)

names(past_meetings$resource[[1]]$group)

So I guess, it would be better to take out past_event_count_inclusive for now.

Where the optional fields parameters are in the range of 30 - 40 different parameters for get_events(), would you like to hardcode say, all 40 parameters in the fields description? I see that the parameters are many in v3.

ledell · 2019-06-06T20:40:36Z

Another thing to decide on -- right now, if you want to get multiple fields, you pass a single comma delimited string. In R, people would be used to passing a character vector with multiple string values... so which input type is better?

Current:

past_meetups <- get_events(urlname = urlname, 
                           event_status = "past", 
                           fields = "event_hosts, featured", 
                           api_key = api_key)

Other option:

past_meetups <- get_events(urlname = urlname, 
                           event_status = "past", 
                           fields = c("event_hosts", "featured"), 
                           api_key = api_key)

Or we can support both.

benubah · 2019-06-06T21:30:10Z

@ledell @LucyMcGowan Thank you for looking into this. I will look into all the concerns raised and will feedback soon.

benubah · 2019-06-07T08:41:55Z

Another thing to decide on -- right now, if you want to get multiple fields, you pass a single comma delimited string. In R, people would be used to passing a character vector with multiple string values... so which input type is better?

Current:
past_meetups <- get_events(urlname = urlname, 
                           event_status = "past", 
                           fields = "event_hosts, featured", 
                           api_key = api_key)
Other option:
past_meetups <- get_events(urlname = urlname, 
                           event_status = "past", 
                           fields = c("event_hosts", "featured"), 
                           api_key = api_key)
Or we can support both.

Yes, I have now added support for both.

benubah · 2019-06-28T13:28:35Z

@benubah Here's what I suggest -- let's leave fields defaulting to NULL, but in the fields parameter description, let's hardcode the list of options so the user does not have to leave the R terminal and go to the web to look them up.

@ledell Could you please look into this:

" where the optional fields parameters are in the range of 30 - 40 different parameters for get_events() in the meetup API, would you like to hard-code say, all 40 parameters in the fields description while documenting the function? I see that the parameters are many in v3."

ledell · 2019-07-04T16:08:39Z

@benubah

" where the optional fields parameters are in the range of 30 - 40 different parameters for get_events() in the meetup API, would you like to hard-code say, all 40 parameters in the fields description while documenting the function? I see that the parameters are many in v3."

Feel free to use your judgement on this one... I think you're right that 30-40 params would be too much for the docs. Maybe if there are >10, we should just reference a URL that lists them?

…gle string of comma separated values

RickPack · 2019-10-21T10:22:17Z

I am presenting about this work as one of the Google Summer of Code 2019 mentors on Tuesday, October 22, 2019. Might someone give me a quick comment about the current status that helps one understand why Ben's work has not yet been merged into the main meetupr repo? I see there are conflicting files.
Might you have thoughts about how I or someone else can help?

ledell · 2020-10-06T22:42:18Z

Hi @benubah and @RickPack -- sorry for dropping the ball on this. I was low on bandwidth at the time we were having this conversation, but I am revisiting some of the outstanding meetupr tasks this week.

It looks like the conflicts are related to the OAuth changes made in Aug 2019. Would one of you be able to fix the conflicts? Once these are fixed, we can get this merged into the package!

The other topic that never got fully resolved was whether it was better to name the parameter something more accurate (like extra_fields), or whether to just re-use the "true" name, fields. I am ok to keep to the "true" name -- anyone else have final thoughts on that?

RickPack · 2020-10-08T01:27:45Z

I am using the meetupr package for a Tuesday presentation and will look at this over the weekend. Tuesday presentation = TriPASS Data Science: Using the meetupr Package http://meetu.ps/e/JqlKk/2MGw5/a

…

On Oct 6, 2020, at 6:42 PM, Erin LeDell ***@***.***> wrote: Hi @benubah and @RickPack -- sorry for dropping the ball on this. I was low on bandwidth at the time we were having this conversation, but I am revisiting some of the meetupr stuff this week. It looks like the conflicts are related to the OAuth changes made in Aug 2019. Would one of you be able to fix the conflicts? Once these are fixed, we can get this merged into the package! The other topic that never got fully resolved was whether it was better to name the parameter something more accurate (like extra_fields), or whether to just re-use the "true" name, fields. I am ok to keep to the "true" name -- anyone else have final thoughts on that? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe.

ledell · 2020-10-08T02:01:45Z

Hi @RickPack that's great! If you have time to resolve the conflicts over the weekend, then I can merge it as soon as you tell me you're done. Thanks!

RickPack · 2020-10-12T01:54:56Z

EDIT: Ben, do you mind if I submit a PR that just takes the current meetupr code and adds: 1) Ben's edit to R/internals.R loops the same function used previously (quick_fetch, not modified by Ben). 2) Ben's edit to R/find_groups.R simply enables the fields and topic_id objects to be multi-length vectors. Or you can do so and scrap this PR. I am not sure if the merge will cause the loss of edits like the ellipses in the following from internals.R as well as the elimination of the api_key argument (see merged GregSutcliffe@59d2b6c) res <- .quick_fetch(api_url, event_status = event_status, ...) I have not worked with Github in this collaborative way in many months.

ledell · 2020-10-15T00:50:43Z

I'm just tagging @benubah to make sure he sees your comments, @RickPack. Hopefully we can get the conflicts resolved and this merged soon! :-)

ledell · 2020-10-15T06:00:55Z

Also @benubah please add your name in the DESCRIPTION file as a contributor to the package (role = "ctb")! I'd love to get your three PRs merged soon.

RickPack · 2020-10-15T13:10:30Z

I also emailed @benubah and have not heard from him. I think I'll have time Sunday to convert his work into a new PR and credit him as you described.

…

On Thu, Oct 15, 2020 at 2:01 AM Erin LeDell ***@***.***> wrote: Also @benubah <https://github.com/benubah> please add your name in the DESCRIPTION file as a contributor to the package (role = "ctb")! I'd love to get your three PRs merged soon. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#48 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAVDF43QLQNL6PA357O6TCTSK2F2NANCNFSM4HRWNJWA> .

-- Regards, Rick Pack Email: [email protected] LinkedIn: https://www.linkedin.com/in/rick-pack-mappstat-5320387/

benubah · 2020-10-16T07:54:12Z

Hi @RickPack @ledell , Sorry I have not had time to respond.
I hope to look at this over this weekend. Let me see if I can resolve all these conflicts at once.
Thanks for inviting me to be a contributor.

Merge branch 'patch-1' of https://github.com/benubah/meetupr into patch-1 # Conflicts: # DESCRIPTION

benubah · 2020-10-16T18:10:47Z

All fixed!

ledell

Thanks @benubah!

benubah added 3 commits May 31, 2019 09:41

added fields to the documentation

ebd217e

update doc and .Rd file

dc4a753

benubah mentioned this pull request May 31, 2019

Add fields argument to find_groups() to retrieve optional fields #46

Closed

Add fields to get_events() to be able to return optional fields lik…

a51e36e

…e `event_hosts`

ledell requested review from ledell and LucyMcGowan June 3, 2019 18:49

ledell self-assigned this Jun 6, 2019

LucyMcGowan approved these changes Jun 6, 2019

View reviewed changes

ledell reviewed Jun 6, 2019

View reviewed changes

support both character vector and single comma delimited string

b0dc11a

benubah mentioned this pull request Jul 1, 2019

Bug in internals.R? #55

Closed

ledell mentioned this pull request Jul 4, 2019

add support in .fetch_results for retrieving results in multiple pages #57

Closed

benubah added 2 commits July 4, 2019 21:38

add offset parameter to .quick_fetch() calls to address rladies#55

602ab59

adding support for multiple topic_ids and fields using vectors or sin…

6c82afe

…gle string of comma separated values

ledell self-requested a review October 6, 2020 22:43

ledell assigned benubah Oct 15, 2020

benubah added 7 commits October 16, 2020 10:30

Merge branch 'master' into patch-1

0916f44

add default

2cd3955

update

d2dc4ce

updates

c4f1c1d

Merge branch 'patch-1' of https://github.com/benubah/meetupr into patch-1 # Conflicts: # DESCRIPTION

update PR

75d03b3

added Ben as ctb

3c060eb

added Ben as ctb

61cd2b1

ledell approved these changes Oct 17, 2020

View reviewed changes

ledell merged commit e5344f4 into rladies:master Oct 17, 2020

ledell mentioned this pull request Oct 20, 2020

Consider adding a column for each field specified in the fields parameter #77

Open

ledell mentioned this pull request Feb 7, 2021

Fill in NEWS.md file with recent updates #102

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added `fields` to `find_groups()` to retrieve optional fields from M… #48

added `fields` to `find_groups()` to retrieve optional fields from M… #48

benubah commented May 31, 2019 •

edited

Loading

benubah commented May 31, 2019

ledell commented Jun 6, 2019 •

edited

Loading

LucyMcGowan commented Jun 6, 2019

ledell commented Jun 6, 2019 •

edited

Loading

LucyMcGowan commented Jun 6, 2019

ledell commented Jun 6, 2019

ledell Jun 6, 2019

benubah Jun 6, 2019

ledell Jun 6, 2019 •

edited

Loading

ledell Jun 6, 2019 •

edited

Loading

benubah Jun 7, 2019

benubah Jun 7, 2019

ledell commented Jun 6, 2019 •

edited

Loading

benubah commented Jun 6, 2019

benubah commented Jun 7, 2019

benubah commented Jun 28, 2019

ledell commented Jul 4, 2019

RickPack commented Oct 21, 2019

ledell commented Oct 6, 2020 •

edited

Loading

RickPack commented Oct 8, 2020 via email

ledell commented Oct 8, 2020

RickPack commented Oct 12, 2020 via email •

edited

Loading

ledell commented Oct 15, 2020

ledell commented Oct 15, 2020

RickPack commented Oct 15, 2020 via email

benubah commented Oct 16, 2020

benubah commented Oct 16, 2020

ledell left a comment

added fields to find_groups() to retrieve optional fields from M… #48

added fields to find_groups() to retrieve optional fields from M… #48

Conversation

benubah commented May 31, 2019 • edited Loading

benubah commented May 31, 2019

ledell commented Jun 6, 2019 • edited Loading

LucyMcGowan commented Jun 6, 2019

ledell commented Jun 6, 2019 • edited Loading

LucyMcGowan commented Jun 6, 2019

ledell commented Jun 6, 2019

ledell Jun 6, 2019

Choose a reason for hiding this comment

benubah Jun 6, 2019

Choose a reason for hiding this comment

ledell Jun 6, 2019 • edited Loading

Choose a reason for hiding this comment

ledell Jun 6, 2019 • edited Loading

Choose a reason for hiding this comment

benubah Jun 7, 2019

Choose a reason for hiding this comment

benubah Jun 7, 2019

Choose a reason for hiding this comment

ledell commented Jun 6, 2019 • edited Loading

benubah commented Jun 6, 2019

benubah commented Jun 7, 2019

benubah commented Jun 28, 2019

ledell commented Jul 4, 2019

RickPack commented Oct 21, 2019

ledell commented Oct 6, 2020 • edited Loading

RickPack commented Oct 8, 2020 via email

ledell commented Oct 8, 2020

RickPack commented Oct 12, 2020 via email • edited Loading

ledell commented Oct 15, 2020

ledell commented Oct 15, 2020

RickPack commented Oct 15, 2020 via email

benubah commented Oct 16, 2020

benubah commented Oct 16, 2020

ledell left a comment

Choose a reason for hiding this comment

added `fields` to `find_groups()` to retrieve optional fields from M… #48

added `fields` to `find_groups()` to retrieve optional fields from M… #48

benubah commented May 31, 2019 •

edited

Loading

ledell commented Jun 6, 2019 •

edited

Loading

ledell commented Jun 6, 2019 •

edited

Loading

ledell Jun 6, 2019 •

edited

Loading

ledell Jun 6, 2019 •

edited

Loading

ledell commented Jun 6, 2019 •

edited

Loading

ledell commented Oct 6, 2020 •

edited

Loading

RickPack commented Oct 12, 2020 via email •

edited

Loading