The hardware and bandwidth for this mirror is donated by dogado GmbH, the Webhosting and Full Service-Cloud Provider. Check out our Wordpress Tutorial.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]dogado.de.

API Contract

API Contract for shinyseo

This page is written so another agent can use the package without reading the source.

Exported surface

There are no other exported helpers.

Return value

social_meta() returns a shiny::tags$head() fragment.

You normally place it inside a Shiny UI definition, for example:

shinyseo::social_meta(list(
  title = "Hello",
  description = "Short app description.",
  url = "https://example.no",
  image = "https://example.no/share.png"
))

Input contract

meta can be one of:

If meta is a character string, the package reads it with yaml::read_yaml().

If the file does not exist, the function stops with:

Required fields

These keys must exist in the final metadata object:

The function checks only that the names exist. It does not currently validate that the values are non-empty strings.

If any required key is missing, the function stops with:

Defaults

The package fills these defaults when the key is missing or NULL:

Important detail:

Output tags

The function writes these tags into the returned head fragment:

Field map

Key Used for
title Page title, Open Graph title, Twitter title, schema name
description Meta description, Open Graph description, Twitter description, schema description
url Canonical URL, Open Graph URL, Twitter URL, schema URL
image Open Graph image, Twitter image
locale Open Graph locale, schema language default
robots Robots meta tag
twitter_card Twitter card type
twitter_site Twitter site handle
twitter_creator Twitter creator handle
twitter_image_alt Twitter image alt text
image_alt Open Graph image alt text
image_width Open Graph image width
image_height Open Graph image height
image_type Open Graph image MIME type
bing_site_verification Bing Webmaster verification
google_site_verification Google Search Console verification
schema_type Schema.org @type
application_category Schema.org applicationCategory
operating_system Schema.org operatingSystem
educational_use Schema.org educationalUse
is_accessible_for_free Schema.org isAccessibleForFree
disclaimer Schema.org disclaimer
author_name Schema.org author.name
author_type Schema.org author.@type
publisher_name Schema.org publisher.name
publisher_type Schema.org publisher.@type
in_language Schema.org inLanguage
schema Turns JSON-LD on or off

Behavior notes

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.
Health stats visible at Monitor.