Allow fetching original files instead of forcing the processed vector file

[KamilSJaron]

Is your feature request related to a problem? Please describe.

When one fetches vector or even raster file, the package usually fetches the processed vector file (the only exception is when the height matches resolution of already generated raster file). That sometimes leads to strange artefacts introduced during standardisation of silhouettes (e.g. deleting all grey surfaces).

Describe the solution you'd like

I would like to
a. do the raster conversion using the original, not the vector files (that is the submission, not standartised)
b. allow third type, 'vector', 'raster', 'original' that would return the submitted file whatever that is

Describe alternatives you've considered

I am now dissecting the package to find that it's not that hard to adjust the functions and do it without the package altogether, but perhaps it would be good to get this done for everyone to enjoy. So, my question is... You you take a PR if I get this done?

Additional context

This is one example where the processed vector file does not look very good. Left, plotted by the R package (which is matching the vector file on pylopic.org) and on right is the default render, which is made out of the original file (which is also available).

[KamilSJaron]

Ha, I did a tiny bit of digging and the right answer is not that simple...

When I fetch the original file, it still undergoes though some form of transformation and I am not sure where exactly...

Here is a screenshot of 4 files with a gently modified version of your package that allows for "source" (in api they are called source, on webpage "original", sorry for using them interchangibly) files:

[KamilSJaron]

For reproducibility purposes. In get_phylopic.R file I changed the decision making section of the get_phylopic function as follows:

  format <- match.arg(as.character(format), c("raster", "vector", "source")) # HERE, allow for "source" as an option
  image_info <- phy_GET(file.path("images", uuid))$`_links`
  if (format == "raster") { # get raster
    rasters <- image_info$rasterFiles
    # check if there is an existing file with the desired height
    ind <- grepl(paste0("x", height), rasters$sizes)
    if (any(ind)) {
      url <- rasters$href[ind]
      img <- get_png(url)
    } else {
      url <- image_info$sourceFile$href # HERE raster conversion if not supplied right height comes from the source file
      # use the svg to make a png with the desired height
      img <- make_png(url, height)
    }
    class(img) <- c("phylopic", class(img))
  } else if (format == "vector") { # get vector
    url <- image_info$vectorFile$href
    img <- get_svg(url)
  } else if (format == "source") { # get source file; HERE is the change 2; allowing to simply fetch the original file
    url <- image_info$sourceFile$href
    img <- get_svg(url)
  }

and than the plot is...

fruitfly_uuid <- "be776840-35e4-45a8-87be-b0a39d22bd56"

vector_fruitfly <- get_phylopic(fruitfly_uuid, format = 'vector')
original_fruitfly <- get_phylopic(fruitfly_uuid, format = 'source')
raster_fruitfly <- get_phylopic(fruitfly_uuid, format = 'raster')
raster2_fruitfly <- get_phylopic(fruitfly_uuid, format = 'raster', height = 1295)

plot(NULL, xlim = c(0,3), ylim = c(0, 3), type = "n", ann = FALSE, axes = F)

add_phylopic_base(img = raster_fruitfly, x = 2, y = 1, height = 0.5)
add_phylopic_base(img = vector_fruitfly, x = 1, y = 1, height = 0.5)
add_phylopic_base(img = raster2_fruitfly, x = 2, y = 2, height = 0.5)
add_phylopic_base(img = original_fruitfly, x = 1, y = 2, height = 0.5)

[willgearty]

Thanks for opening this issue @KamilSJaron! I'll look into this as soon as I get a free moment. If you do find a solution, please feel free to open a pull request.

[willgearty]

Since this is also a problem with the processed vector file that is hosted on phylopic.org, I'm going to tag @keesey as well. There may be some improvements that can be done on the PhyloPic side of things.