geogit_location: Import Github users from a specific location

Description Usage Arguments Details Value Examples

Description

This function retrieves Github users from a specific location

Usage

1
geogit_location(location, token, page = 1, sort = "followers")

Arguments

location

Desired location to explore e.g. Morocco

token

The geogit_token that contains access token information. If not provided, the anonymous user token is used.

page

Page number of search results. Maximum value is 10.

sort

Value to sort followers by. You can sort users by followers, repositories, or joined (account creation timestamp).

Details

The first 100 users who match the location are returned. By default, the first page of the search is returned and the users are sorted by number of followers. Each search page has a maximum of 100 search results, and you can access the other search pages by changing the page parameter. Github API limits the number of searches that can be retrieved to 1000 (10 pages). Only users with at least 1 repository on Github are retrieved using this function. This function is particulatly useful for retrieving the usernames that match a location. To retrieve more information about a user, you can use geogit_user.

Value

A tibble that contains the users that match the given location.

Examples

1
2
3
4
token <- geogit_token()
geogit_location("Morocco", token)
geogit_location("Morocco", token, page = 2)
geogit_location("Morocco", token, sort = "repositories")

abelemlih/geogit documentation built on May 25, 2019, 2:24 p.m.