SocialMediaLab (version 0.22.0)

CollectEgoInstagram: Note: this function is DEPRECATED and will be removed in a future release. Please use the Collect function

Description

Collect Instagram data for generating ego network

Usage

CollectEgoInstagram(username, userid, verbose, degreeEgoNet, waitForRateLimit, getFollows, credential = NULL)

Arguments

username

character vector, specifying a set of usernames who will be the 'ego' nodes for the network generation.

userid

character vector, specifying a set of usernames who will be the 'ego' nodes for the network generation.

verbose

logical. If TRUE then this function will output runtime information to the console as it computes. Useful diagnostic tool for long computations. Default is FALSE.

degreeEgoNet

Numeric, the 'order' or 'degree' of the ego-network to create (1 is default). 1 = ego + alters. 2 = ego + alters + alters of alters.

waitForRateLimit

logical. If TRUE then it will try to observe the API rate limit by ensuring that no more than 5000 API calls are made per hour (the current rate limit). If more than 5000 calls are made within a 60 minute window, then all operates will suspend for 60 minutes, and resume afterwards. Note: API calls are only tracked within the scope of this function.

getFollows

Logical, if TRUE (default), also collect who each 'ego' node itself follows (i.e. not just the followers of ego), and integrate these data into the ego network.

credential

credential object. Credential information to be use with API calls. Default to NULL, meaning using the API credential information store in the current workspace.

Value

A data frame object of class dataSource.instagram.ego that can be used with Create.

Details

This function collects data for creating a (weighted and directed) 'ego' network from a given set of seed users (the ego nodes). Note! The network size can become extremely large very quickly, depending on the arguments the user provides to this function. For example, specifying degreeEgoNet=2 and getFollows=TRUE can generate very large networks from just a small number of ego users (even just 3 or 4 ego nodes).

Examples

## Not run: 
# myAppID <- "123456789098765"
# myAppSecret <- "abc123abc123abc123abc123abc123ab"
# 
# # Authenticate with the Instagram API using `AuthenticateWithInstagramAPI`
# instagram_oauth_token <- AuthenticateWithInstagramAPI(appID=myAppI,
# appSecret=myAppSecret, useCachedToken=TRUE)
# 
# myUsernames <- c("senjohnmccain","obama")
# instagramEgodata <- CollectEgoInstgram(username=myUsernames,
# verbose=TRUE,degreeEgoNet=1, waitForRateLimit=TRUE,
# getFollows=FALSE)
# Create(instagramEgodata)
# ## End(Not run)