search_Met_objects: Return object data based on search paramaters

In athvedt/theMetR: Provides Easy Access to the Metropolitan Museum's Open Access API

Description

This function searches for all objects in the Met's Open Access database that match the search parameters. The user can also use this function to download data on a number of these objects (5 by default) and download the images (off by default). Some of these arguments come directly from the parameters in the Met's API. In these cases, the same descriptions are used.

Usage

search_Met_objects(
  q = "",
  departmentID = "",
  isHighlight = FALSE,
  isOnView = FALSE,
  artistOrCulture = FALSE,
  medium = "",
  hasImages = FALSE,
  geoLocation = "",
  dateBegin = "",
  dateEnd = "",
  limit = 5,
  download_images = FALSE
)

Arguments

q	Search query. Returns a listing of all Object IDs for objects that contain the search query anywhere within the object’s data.
departmentID	Returns objects that are a part of a specific department. Use 'get_department_IDs()' function to explore available departments and their associated IDs.
isHighlight	If TRUE, filters for objects that match the query and are designated as highlights. Highlights are selected works of art from The Met Museum’s permanent collection representing different cultures and time periods.
isOnView	If TRUE, filters for objects that match the query and are on view in the museum.
artistOrCulture	If TRUE, filters for objects that match the query, specifically searching against the artist name or culture field for objects.
medium	Returns objects that match the query and are of the specified medium or object type. Examples include: Ceramics, Furniture, Paintings, Sculpture, Textiles, etc.
hasImages	If TRUE, filters for objects that match the query and have images.
geoLocation	Returns objects that match the query and the specified geographic location. Examples include: Europe, France, Paris, China, New York, etc.
dateBegin	Returns objects that match the query and fall between the dateBegin and dateEnd parameters. Must also be used with dateEnd argument.
dateEnd	Returns objects that match the query and fall between the dateBegin and dateEnd parameters. Must also be used with dateBegin argument.
limit	Limits the number of objects that have data included in the output. Defaults to 5.
download_images	If TRUE, downloads primary image files of each object in the query. Observes limit paramater. Defaults to FALSE.

athvedt/theMetR documentation built on May 31, 2020, 11:08 p.m.