Datasets and Functions Relating to Star Trek

Provides datasets related to the Star Trek fictional universe and functions for working with the data. The package also provides access to real world datasets based on the televised series and other related licensed media productions. It interfaces with the Star Trek API (STAPI) (< http://stapi.co/>), Memory Alpha (< http://memory-alpha.wikia.com/>), and Memory Beta (< http://memory-beta.wikia.com/>) to retrieve data, metadata and other information relating to Star Trek. It also contains several local datasets covering a variety of topics. The package also provides functions for working with data from other Star Trek-related R data packages containing larger datasets not stored in 'rtrek'.


rtrek

Author: Matthew Leonawicz gitter
License: MIT

CRAN status CRAN downloads Rdoc Travis-CI Build Status AppVeyor Build Status Coverage Status

The rtrek package provides datasets related to the Star Trek fictional universe and functions for working with those datasets. It interfaces with the Star Trek API (STAPI), Memory Alpha and Memory Beta to retrieve data, metadata and other information relating to Star Trek.

The package also contains several local datasets covering a variety of topics such as Star Trek timeline data, universe species data and geopolitical data. Some of these are more information rich, while others are toy examples useful for simple demonstrations. The bulk of Star Trek data is accessed from external sources by API. A future version of rtrek will also include summary datasets resulting from text mining analyses of Star Trek novels.

Note: This package is in beta (and not just the quadrant). Breaking changes may occur.

Image: Example Leaflet map using non-geographic Star Trek map tiles.


Installation

Install rtrek from CRAN with:

install.packages("rtrek")

Install the development version of rtrek from GitHub with:

devtools::install_github("leonawicz/rtrek")

Examples

These are just a few examples to help you jump right in. See the package articles for more.

STAPI

Use the Star Trek API (STAPI) to obtain information on the infamous character, Q. Specifically, retrieve data on his appearances and the stardates when he shows up. The first API call does a lightweight, unobtrusive check to see how many pages of potential search results exist for characters in the database. There are a lot of characters. The second call grabs only page two results. The third call uses the universal/unique ID uid to retrieve data on Q. Think of these three successive uses of stapi as safe mode, search mode and extraction mode.

library(rtrek)
library(dplyr)
stapi("character", page_count = TRUE)
#> Total pages to retrieve all results: 64
 
stapi("character", page = 2)
#> # A tibble: 100 x 24
#>    uid   name  gender yearOfBirth monthOfBirth dayOfBirth placeOfBirth
#>    <chr> <chr> <chr>        <int> <lgl>        <lgl>      <chr>       
#>  1 CHMA~ Stev~ <NA>            NA NA           NA         <NA>        
#>  2 CHMA~ Yegg~ M               NA NA           NA         <NA>        
#>  3 CHMA~ Arex  M               NA NA           NA         <NA>        
#>  4 CHMA~ Jose~ M               NA NA           NA         <NA>        
#>  5 CHMA~ J. Z~ <NA>            NA NA           NA         <NA>        
#>  6 CHMA~ Doyle M               NA NA           NA         <NA>        
#>  7 CHMA~ Butl~ M               NA NA           NA         <NA>        
#>  8 CHMA~ Lito  M               NA NA           NA         <NA>        
#>  9 CHMA~ B. M~ <NA>            NA NA           NA         <NA>        
#> 10 CHMA~ Anna~ <NA>            NA NA           NA         <NA>        
#> # ... with 90 more rows, and 17 more variables: yearOfDeath <int>,
#> #   monthOfDeath <lgl>, dayOfDeath <lgl>, placeOfDeath <lgl>,
#> #   height <int>, weight <int>, deceased <lgl>, bloodType <lgl>,
#> #   maritalStatus <chr>, serialNumber <chr>, hologramActivationDate <lgl>,
#> #   hologramStatus <lgl>, hologramDateStatus <lgl>, hologram <lgl>,
#> #   fictionalCharacter <lgl>, mirror <lgl>, alternateReality <lgl>
 
Q <- "CHMA0000025118"  #unique ID
Q <- stapi("character", uid = Q)
Q$episodes %>% select(uid, title, stardateFrom, stardateTo)
#>              uid                 title stardateFrom stardateTo
#> 1 EPMA0000001458    All Good Things...      47988.0    47988.0
#> 2 EPMA0000001329                 Q Who      42761.3    42761.3
#> 3 EPMA0000001377                  Qpid      44741.9    44741.9
#> 4 EPMA0000000483 Encounter at Farpoint      41153.7    41153.7
#> 5 EPMA0000000651              Tapestry           NA         NA
#> 6 EPMA0000000845                Q-Less      46531.2    46531.2
#> 7 EPMA0000162588            Death Wish           NA         NA
#> 8 EPMA0000001413                True Q      46192.3    46192.3
#> 9 EPMA0000001510    The Q and the Grey      50384.2    50392.7

Memory Alpha

Obtain content and metadata from the article about Spock on Memory Alpha:

x <- ma_article("Spock")
x
#> # A tibble: 1 x 4
#>   title content           metadata          categories       
#>   <chr> <list>            <list>            <list>           
#> 1 Spock <S3: xml_nodeset> <tibble [1 x 17]> <tibble [14 x 2]>
x$metadata[[1]]$Born
#> [1] "January 6, 2230 (stardate 2230.06)|ShiKahr, Vulcan"

Memory Beta

Spock was born in 2230. Obtain a subset of the Star Trek universe historical timeline for that year:

mb_timeline(2230)
#> 2230
#> $events
#> # A tibble: 5 x 4
#>   period id            date  notes                                         
#>   <chr>  <chr>         <chr> <chr>                                         
#> 1 2230   Events        <NA>  Argelius II  and Betelgeuse become members of~
#> 2 2230   Births_and_D~ <NA>  Spock is born deep within a cave in Vulcan's ~
#> 3 2230   Births_and_D~ <NA>  George Samuel Kirk, Jr. is born.[5]           
#> 4 2230   Births_and_D~ <NA>  David Rabin is born.[6]                       
#> 5 2230   Births_and_D~ <NA>  Roy John Moss is born.[7]                     
#> 
#> $stories
#> # A tibble: 5 x 11
#>   title title_url colleciton collection_url section context series date 
#>   <chr> <chr>     <chr>      <chr>          <chr>   <chr>   <chr>  <chr>
#> 1 Burn~ Burning_~ <NA>       <NA>           Chapte~ <NA>    The O~ 2230 
#> 2 Star~ Star_Tre~ <NA>       <NA>           Chapte~ <NA>    The O~ 2230 
#> 3 IDW ~ IDW_Star~ Star Trek~ Star_Trek_(ID~ 2230 f~ <NA>    The O~ 2230 
#> 4 Star~ Star_Tre~ <NA>       <NA>           Chapte~ <NA>    The O~ 2230 
#> 5 Sarek Sarek_(n~ <NA>       <NA>           Chapte~ <NA>    The O~ 12 N~
#> # ... with 3 more variables: media <chr>, notes <chr>, image_url <chr>

Live long and prosper.

See the introduction vignette for more details and examples.

Reference

Complete package reference and function documentation


Please note that the rtrek project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

News

rtrek 0.2.0

  • Added an initial version of an API function memory_alpha along with a collection of internal support functions for accessing Star Trek data from web portals available on the Memory Alpha website.
    • Internal portal functions that return data from portal and portal category web pages, and which may run recursively when necessary to compile complete content over multiple pages, are memoized.
    • Functions like ma_article, which return article content from a terminal endpoint are not memoized.
  • Added ma_search function for using the Memory Alpha site search via URL parameters.
  • Added ma_image function for downloading source images from Memory Alpha and loading into R as ggplot objects.
  • Added an initial version of an API function memory_beta and other mb_* Memory Beta analogs to Memory Alpha website functions.
  • Added mb_timeline for working with data from the Memory Beta Chronology.
  • Added new datasets, mainly to timelines: tlBooks, tlEvents, tlFootnotes. Also added stSeries names and abbreviations table.
  • Renamed st_book_series and stBooksWP to st_books_wiki and stBooksWiki, respectively.
  • Updated tile set URLs.
  • Updated stBooks dataset. This data frame now has better formatting, greater consistency, duplicates removed, and contains more entries than before. It is still incomplete and imperfect, but much improved over the previous version.
  • Updated stBooksWiki dataset. Updated column names for consistency.
  • Updates the acronyms used in the package for consistency.
  • Update unit tests, added unit tests for Memory Alpha and Memory Beta functions.
  • Updated function documentation.
  • Updated introduction vignette sections. Added new section relating to timeline datasets.
  • Added three new vignettes for each of the three API options: STAPI, Memory Alpha, and Memory Beta.
  • Minor bug fixes.

rtrek 0.1.0

  • Refactored some functions and datasets.
  • Added new stBooks dataset, renamed previous stBooks to stBooksWP.
  • Added connection to new map tile set, galaxy2.
  • Add two more species/homeworlds to example data.
  • Updated documentation.
  • Added and updated unit tests.

rtrek 0.0.9

  • Remove remote trekfont now that it is available on CRAN.
  • Prepare GitHub accessible external datasets that serve package web pages.
  • Updated documentation, website. Add to "fun pages" (R & R), which are only part of website "vignettes", not package vignettes.
  • Minor fixes.

rtrek 0.0.8

  • Added more robust testing of API entity searches.
  • Minor refactor of stapi internals and addition of stapiEntities dataset.
  • Added optional (non-dependent) association with trekfont package with a function st_font to list and preview fonts from that package.
  • Updated documentation.
  • Minor fixes.

rtrek 0.0.7

  • Added additional vignettes.
  • Optional integration with trekfont package.
  • Improved website, including initial version of Stellar Cartography page.
  • Update data.
  • Minor fixes.
  • Updated readme and docs.

rtrek 0.0.6

  • Added initial introduction vignette content.
  • Added anti-DDOS measures for API calls.
  • Minor fixes.
  • Updated unit tests.
  • Updated readme.

rtrek 0.0.5

  • Added initial Star Trek data API functionality via STAPI wrapper.
  • Updated documentation.
  • Added unit tests.
  • Added moderately curated data frame of Star Trek novels metadata scraped from Wikipedia.
  • Added convenience function for accessing specific Wikipedia entries in browser.

rtrek 0.0.1

  • Added minimal data and functions.
  • Added basic unit tests.
  • Updated documentation, improved dataset and object curation.

rtrek 0.0.0.9000

  • Added initial package scaffolding.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("rtrek")

0.2.0 by Matthew Leonawicz, 3 months ago


https://github.com/leonawicz/rtrek


Report a bug at https://github.com/leonawicz/rtrek/issues


Browse source code at https://github.com/cran/rtrek


Authors: Matthew Leonawicz [aut, cre]


Documentation:   PDF Manual  


MIT + file LICENSE license


Imports magrittr, dplyr, jsonlite, xml2, rvest, jpeg, purrr, ggplot2, memoise, tibble, tidyr, downloader

Suggests testthat, knitr, rmarkdown, covr, leaflet, lintr, showtext, sysfonts, trekfont


See at CRAN