getcompany: Get a list of companies, intelligently filtered by several...
In brandywwy/Rmuse: R Interface to THE MUSE API

Description Usage Arguments Value Examples

View source: R/getcompany.R

This function can make request THE MUSE API with "companies" endponit to get a list of companies. The results it will return include the name of the company, a brief description of the company, its location, related industries, its tag, the size, official website, twitter, images, etc.

1 2	getcompany(page = NULL, decending = FALSE, industry = NULL, size = NULL, location = NULL, apikey = NULL)

`page`	The page number to load (required).
`decending`	Whether to show descending results (default value: FALSE).
`industry`	The company industry to get, please refer to the vignette for available industry categories.
`size`	The company size to get, please refer to the vignette for available size choice.
`location`	The office location to get.
`apikey`	Pass your own API key can increase the rate limit from 500 to 3600 per hour.

A named list with the following elements:

message: a list of messages including the number of results in specified pages, total number of results returned by the API
response: a list of API-specific response values in JSON format, including the name of the company, a brief description of the company, its location, related industries, its tag, the size, official website, twitter, images, etc. At this time, no further coercion is performed, so you may have to use functions from the jsonlite package to extract the desired output. Or you can refer to the "cleancompany" function in this package to get a clean dataframe with some key information of list of companies.

## Not run: 
getcompany(page = 1)
getcompany(page = 1, industry = "Tech")
getcompany(page = 1, size = "Large Size", location = "New York City, NY")
## End(Not run)