photosearcher
Searches Flickr for photographs and metadata
Science Score: 49.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in README -
✓Academic publication links
Links to: sciencedirect.com, nature.com -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (20.6%) to scientific vocabulary
Last synced: 6 months ago
·
JSON representation
Repository
Searches Flickr for photographs and metadata
Basic Info
- Host: GitHub
- Owner: ropensci
- Language: R
- Default Branch: master
- Homepage: https://docs.ropensci.org/photosearcher
- Size: 418 MB
Statistics
- Stars: 16
- Watchers: 5
- Forks: 14
- Open Issues: 7
- Releases: 0
Created about 7 years ago
· Last pushed 10 months ago
Metadata Files
Readme
Contributing
Code of conduct
Codemeta
README.Rmd
---
output: github_document
---
[](https://travis-ci.org/ropensci/photosearcher) [](https://codecov.io/gh/ropensci/photosearcher?branch=master) [](https://www.repostatus.org/#active)
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# photosearcher 
The goal of photosearcher is to provide a repeatable methodology for accessing the Flickr API. More information can be found on the [package website](https://docs.ropensci.org/photosearcher/). For more information and examples of the functions check out the [package vignette](https://docs.ropensci.org/photosearcher/articles/photosearcher.html).
We have produced this package to help facilitate reproducible code for answering research questions. In the PLoS journals alone there are over 180 articles with Flickr in their keywords. [Click here]( https://docs.ropensci.org/photosearcher/articles/flickr_in_research.html) for an overview of the use of Flickr in PLoS journals. Articles using Flickr are published in a wide range of journals for a wide range of research fields including [biology and life sciences](https://www.nature.com/articles/s41598-017-18007-4), [computer and information sciences](https://www.inderscience.com/info/inarticle.php?artid=99808), [medicine and health sciences](https://www.sciencedirect.com/science/article/abs/pii/S0272494418303086) and [politics](https://journals.sagepub.com/doi/full/10.1177/1470357218780530?casa_token=UubfU8-MbuAAAAAA%3AAQBSE3ipGOdMi33J6ISalSySECPxvmxvmgDys3-ni7Z5EuQHNGlPMhOxjq6hyfPLmo1tFEIJYCiR).
## Terms of use
This package should be used within accordance of the [Flickr API terms of use](https://www.flickr.com/help/terms/api).
## Installation
You can install the released version of photosearcher from github with:
``` r
devtools::install_github("nfox29/photosearcher")
```
## Getting an API key
The package requires a valid API key from the [Flickr development page](https://www.flickr.com/services/apps/create/). The first time you call a function from the package, you will be prompted to create and enter your API key. The API key will then be saved as photosearcher_key.sysdata in your working directory and is used for all function.
## Package functions
The package currently focuses on the ability to use the Flickr API to search for images and their metadata through the `photo_search` function ([ see the flickr.photos.search method](https://www.flickr.com/services/api/flickr.photos.search.html)) for more information. These photographs can be downloaded using `download_images` function which saves the images as a .jpeg file.
The package also allows users to find the top tags for a given location (`location_tags`) and the tags most commonly associated with a given tag (`related_tags`). The Flickr website offers full [API Documentation](https://www.flickr.com/services/api/) for all of its call methods.
## Searching for photo metadata
In this example, we demonstrate how to search for metadata on all images labelled with the text or keywords *rock climbing* between 2010 and 2019 in the UK and Ireland.
```{r eval=FALSE}
library(photosearcher)
rock_climbing <- photo_search(
mindate_taken = "2010-01-01",
maxdate_taken = "2018-01-01",
text = "rock climbing",
bbox = "-12.875977,49.210420,2.636719,59.977005",
has_geo = TRUE
)
```
When `has_geo == TRUE` only metadata about images with latitude and longitude information will be retrieved.
These can be plotted using other packages at user preference. In the below example, we convert these to an `sf` object and plot using `ggplot2`.
```{r eval=FALSE}
library(sf)
rock_climbing <- st_as_sf(rock_climbing, coords = c("longitude", "latitude"))
library(ggplot2)
ggplot() +
geom_polygon(data = map_data("world", region = c("Ireland", "UK")),
aes(x=long, y = lat, group = group),
fill = "lightgrey") +
geom_sf(data = rock_climbing) +
theme_bw()
```
## Issues and bugs
This package requires an internet connection as well as a connection to the Flickr API, which may not be constantly available.
If you discover a bug not associated with connection to the API that is not already a [reported issue](https://github.com/ropensci/photosearcher/issues), please [open a new issue](https://github.com/ropensci/photosearcher/issues/new) providing a reproducible example.
[](https://ropensci.org)
Owner
- Name: rOpenSci
- Login: ropensci
- Kind: organization
- Email: info@ropensci.org
- Location: Berkeley, CA
- Website: https://ropensci.org/
- Twitter: rOpenSci
- Repositories: 307
- Profile: https://github.com/ropensci
CodeMeta (codemeta.json)
{
"@context": [
"https://doi.org/10.5063/schema/codemeta-2.0",
"http://schema.org"
],
"@type": "SoftwareSourceCode",
"identifier": "photosearcher",
"description": "Queries the Flick API (https://www.flickr.com/services/api/) to \n return photograph metadata as well as the ability to download the images as \n jpegs.",
"name": "photosearcher: Photo Searcher",
"codeRepository": "https://github.com/nfox29/photosearcher",
"issueTracker": "https://github.com/nfox29/photosearcher/issues",
"license": "https://spdx.org/licenses/GPL-3.0",
"version": "1.0",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
"version": "3.6.0",
"url": "https://r-project.org"
},
"runtimePlatform": "R version 3.6.0 (2019-04-26)",
"author": [
{
"@type": "Person",
"givenName": "Nathan",
"familyName": "Fox",
"email": "nf2g13@soton.ac.uk"
},
{
"@type": "Person",
"givenName": "Francesca",
"familyName": "Mancini"
},
{
"@type": "Person",
"givenName": "Laura",
"familyName": "Graham"
},
{
"@type": "Person",
"givenName": "Louis",
"familyName": "Sutter"
},
{
"@type": "Person",
"givenName": "Tom",
"familyName": "August"
}
],
"contributor": {},
"copyrightHolder": {},
"funder": {},
"maintainer": [
{
"@type": "Person",
"givenName": "Nathan",
"familyName": "Fox",
"email": "nf2g13@soton.ac.uk"
}
],
"softwareSuggestions": [
{
"@type": "SoftwareApplication",
"identifier": "httptest",
"name": "httptest",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=httptest"
},
{
"@type": "SoftwareApplication",
"identifier": "knitr",
"name": "knitr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=knitr"
},
{
"@type": "SoftwareApplication",
"identifier": "roxygen2",
"name": "roxygen2",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=roxygen2"
},
{
"@type": "SoftwareApplication",
"identifier": "testthat",
"name": "testthat",
"version": ">= 2.1.0",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=testthat"
},
{
"@type": "SoftwareApplication",
"identifier": "rmarkdown",
"name": "rmarkdown",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=rmarkdown"
},
{
"@type": "SoftwareApplication",
"identifier": "covr",
"name": "covr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=covr"
},
{
"@type": "SoftwareApplication",
"identifier": "rplos",
"name": "rplos",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=rplos"
},
{
"@type": "SoftwareApplication",
"identifier": "wordcloud",
"name": "wordcloud",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=wordcloud"
},
{
"@type": "SoftwareApplication",
"identifier": "tidyverse",
"name": "tidyverse",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=tidyverse"
}
],
"softwareRequirements": [
{
"@type": "SoftwareApplication",
"identifier": "R",
"name": "R",
"version": ">= 3.5.0"
},
{
"@type": "SoftwareApplication",
"identifier": "xml2",
"name": "xml2",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=xml2"
},
{
"@type": "SoftwareApplication",
"identifier": "httr",
"name": "httr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=httr"
},
{
"@type": "SoftwareApplication",
"identifier": "dplyr",
"name": "dplyr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=dplyr"
},
{
"@type": "SoftwareApplication",
"identifier": "glue",
"name": "glue",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=glue"
},
{
"@type": "SoftwareApplication",
"identifier": "clisymbols",
"name": "clisymbols",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=clisymbols"
},
{
"@type": "SoftwareApplication",
"identifier": "crayon",
"name": "crayon",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=crayon"
},
{
"@type": "SoftwareApplication",
"identifier": "sf",
"name": "sf",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=sf"
}
],
"readme": "https://github.com/nfox29/photosearcher/blob/master/README.md",
"fileSize": "3665.002KB",
"contIntegration": [
"https://travis-ci.org/nfox29/photosearcher",
"https://codecov.io/gh/nfox29/photosearcher?branch=master"
],
"developmentStatus": "https://www.repostatus.org/#active"
}GitHub Events
Total
- Issues event: 3
- Issue comment event: 4
- Push event: 2
- Fork event: 1
Last Year
- Issues event: 3
- Issue comment event: 4
- Push event: 2
- Fork event: 1
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 1
- Total pull requests: 0
- Average time to close issues: 3 months
- Average time to close pull requests: N/A
- Total issue authors: 1
- Total pull request authors: 0
- Average comments per issue: 4.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 0
- Average time to close issues: 3 months
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 4.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- wardfont (1)
- maelle (1)
Pull Request Authors
Top Labels
Issue Labels
help wanted (1)
Pull Request Labels
Dependencies
DESCRIPTION
cran
- R >= 3.5.0 depends
- clisymbols * imports
- crayon * imports
- dplyr * imports
- glue * imports
- httr * imports
- lubridate * imports
- sf * imports
- xml2 * imports
- covr * suggests
- httptest * suggests
- knitr * suggests
- rmarkdown * suggests
- roxygen2 * suggests
- rplos * suggests
- testthat >= 2.1.0 suggests
- tidyverse * suggests
- wordcloud * suggests