Package 'streetmixr'

Title: Access the Streetmix API
Description: Support access to the Streetmix API and share data on Streetmix illustrations and components for analysis or reuse (consistent with license requirements).
Authors: Eli Pousson [aut, cre]
Maintainer: Eli Pousson <[email protected]>
License: GPL (>= 3)
Version: 0.1.0
Built: 2024-11-11 02:23:24 UTC
Source: https://github.com/elipousson/streetmixr

Help Index


Streetmix components

Description

Last updated: 2024-11-10

Usage

components

Format

A length 5 nested list with specifications for lanes, markings, objects, vehicles, and effects.

Source

https://github.com/streetmix/streetmix/raw/refs/heads/main/client/src/segments/components.json


Get data on a Streetmix street

Description

Get data on a Streetmix street

Usage

get_street(
  url = NULL,
  user_id = NULL,
  street_id = NULL,
  count = NULL,
  return = "data"
)

Arguments

url

Streetmix url to get data on

user_id

Streetmix user account ID

street_id

Streetmix street ID

count

Count of streets to return

return

Type of data to return based on url: "data", "street", "location", or "segments". If NULL, return full response.


Streetmix CC-BY-SA illustrations

Description

Last updated: 2024-11-10

Data frame with links to SVG files with StreetMix illustrations https://github.com/streetmix/illustrations

Illustrations available under an attribution-share alike license https://github.com/streetmix/illustrations/blob/main/LICENSE

For design guidelines and colors see the illustration guide https://docs.streetmix.net/contributing/illustrations/design-principles

Usage

illustrations

Format

A data frame with 273 rows and 8 variables:

repo

repository

name

illustration name

url

SVG file url

category

category/folder

side

facing side (left or right)

direction

direction of movement (inbound or outbound)

orientation

orientation (parallel, perpendicular, sideways, or angled)

width_type

building width type (narrow or wide)

Source

https://github.com/streetmix/illustrations


Streetmix CC-BY-SA illustrations of people

Description

Last updated: 2024-11-10

Usage

people

Format

A data frame with 36 rows and 5 variables:

id

image id

width

image width

name

image name

disallowFirst

logical

weight

integer

Source

https://github.com/streetmix/streetmix/raw/refs/heads/main/client/src/segments/people.json