Package 'r2social' reference manual

Title:	Seamless Integration of Sharing and Connect Buttons in Markdown and Apps
Description:	Implementation of 'JQuery' <https://jquery.com> and 'CSS' styles to allow easy incorporation of various social media elements on a page. The elements include addition of share buttons or connect with us buttons or hyperlink buttons to 'Shiny' applications or dashboards and 'Rmarkdown' documents.Sharing capability on social media platforms including 'Facebook' <https://www.facebook.com>, 'Linkedin' <https://www.linkedin.com>, 'X/Twitter' <https://x.com>, 'Tumblr' <https://www.tumblr.com>, 'Pinterest' <https://www.pinterest.com>, 'Whatsapp' <https://www.whatsapp.com>, 'Reddit' <https://www.reddit.com>, 'Baidu' <https://www.baidu.com>, 'Blogger' <https://www.blogger.com>, 'Weibo' <https://www.weibo.com>, 'Instagram' <https://www.instagram.com>, 'Telegram' <https://www.telegram.me>, 'Youtube' <https://www.youtube.com>.
Authors:	Obinna Obianom [aut, cre]
Maintainer:	Obinna Obianom <[email protected]>
License:	MIT + file LICENSE
Version:	1.2.1
Built:	2024-10-28 05:20:55 UTC
Source:	https://github.com/oobianom/r2social

Add Connect with us buttons

Description

Buttons for others to connect socially to you

Usage

connectButton(
  link,
  image = NULL,
  text = NULL,
  position = c("left", "right", "inline"),
  display.inline = TRUE,
  link.out = TRUE,
  bg.col = NULL,
  plain = FALSE,
  visit.us = FALSE,
  facebook = FALSE,
  linkedin = FALSE,
  x = FALSE,
  tumblr = FALSE,
  pinterest = FALSE,
  whatsapp = FALSE,
  reddit = FALSE,
  instagram = FALSE,
  blogger = FALSE,
  weibo = FALSE,
  tiktok = FALSE,
  vk = FALSE,
  telegram = FALSE,
  youtube = FALSE
)
connectButton(
  link,
  image = NULL,
  text = NULL,
  position = c("left", "right", "inline"),
  display.inline = TRUE,
  link.out = TRUE,
  bg.col = NULL,
  plain = FALSE,
  visit.us = FALSE,
  facebook = FALSE,
  linkedin = FALSE,
  x = FALSE,
  tumblr = FALSE,
  pinterest = FALSE,
  whatsapp = FALSE,
  reddit = FALSE,
  instagram = FALSE,
  blogger = FALSE,
  weibo = FALSE,
  tiktok = FALSE,
  vk = FALSE,
  telegram = FALSE,
  youtube = FALSE
)

Arguments

`link`	the direct link to connect to
`image`	image link only for pinterest
`text`	text link for X
`position`	position of buttons e.g "left","right","bottom","inline"
`display.inline`	TRUE or FALSE if the button should be inline
`link.out`	visit custom link
`bg.col`	background color for the icons.
`plain`	logical. with or without background
`visit.us`	visit custom link
`facebook`	link to an account on Facebook
`linkedin`	link to an account on Linkedin
`x`	link to an account on X
`tumblr`	link to an account on Tumblr
`pinterest`	link to an account on Pinterest
`whatsapp`	link to an account on Whatsapp
`reddit`	link to an account on Reddit
`instagram`	link to an account on Instagram
`blogger`	link to an account on blogger
`weibo`	link to an account on weibo
`tiktok`	link to an account on tiktok
`vk`	link to an account on VK or VKontakte
`telegram`	link to an account on Telegram
`youtube`	link to an account on Youtube

Value

Connect with me/us button via social links

Examples for r2social

More examples and demo pages are located at this link - https://r2social.obi.obianom.com.

Note

'bg.col' argument is only functional if 'plain' argument is set to false

Examples

connectButton(
link = "//rpkg.net",
visit.us = TRUE,
position = "left")
connectButton(
link = "//www.linkedin.com/in/oobianom",
linkedin = TRUE,
position = "right")
connectButton(
link = "//x.com/R2Rpkg",
x = TRUE, position = "inline")

# NOT styled
connectButton(
link = "//rpkg.net",
visit.us = TRUE,
position = "left")
connectButton(
link = "//www.linkedin.com/in/oobianom",
linkedin = TRUE,
plain = TRUE,
position = "right")
connectButton(
link = "//x.com/R2Rpkg",
x = TRUE, position = "inline")

connectButton(
link = "//rpkg.net",
visit.us = TRUE,
position = "left")
connectButton(
link = "//www.linkedin.com/in/oobianom",
linkedin = TRUE,
position = "right")
connectButton(
link = "//x.com/R2Rpkg",
x = TRUE, position = "inline")

# NOT styled
connectButton(
link = "//rpkg.net",
visit.us = TRUE,
position = "left")
connectButton(
link = "//www.linkedin.com/in/oobianom",
linkedin = TRUE,
plain = TRUE,
position = "right")
connectButton(
link = "//x.com/R2Rpkg",
x = TRUE, position = "inline")

Display Social Links on Profile Card

Description

Social profile card for a any profile

Usage

profileDisplay1(item)
profileDisplay1(item)

Arguments

item

list of profiles along with their image and other items

Value

HTML of social links displayed on a card

Examples


profileDisplay1(
list(
a = list(
  name = "Obi Obianom",
  title = "Senior Scientist",
  image = "https://r2social.obi.obianom.com/misc/team3.jpg",
  social = list(
    list(name = "x",
         link = "https://x.com/R2Rpkg"),
    list(name = "linkedin",
         link = "https://linkedin.com/oobianom"),
    list(name = "website",
         link = "https://obianom.com"),
    list(name = "youtube",
         link = "https://youtube.com/R2Rpkg")
  )
),
b = list(
  name = "William Hane",
  title = "Core Developer",
  image = "https://r2social.obi.obianom.com/misc/team1.jpg",
  social = list(list(name = "youtube",
                     link = "https://youtube.com/R2Rpkg"))
),
c = list(
  name = "Maximillian Qian",
  title = "Code Cleaner",
  image = "https://r2social.obi.obianom.com/misc/team2.jpg",
  social = list(list(name = "facebook",
                     link = "https://facebook.com/R2Rpkg"))
)
))

profileDisplay1(
list(
a = list(
  name = "Obi Obianom",
  title = "Senior Scientist",
  image = "https://r2social.obi.obianom.com/misc/team3.jpg",
  social = list(
    list(name = "x",
         link = "https://x.com/R2Rpkg"),
    list(name = "linkedin",
         link = "https://linkedin.com/oobianom"),
    list(name = "website",
         link = "https://obianom.com"),
    list(name = "youtube",
         link = "https://youtube.com/R2Rpkg")
  )
),
b = list(
  name = "William Hane",
  title = "Core Developer",
  image = "https://r2social.obi.obianom.com/misc/team1.jpg",
  social = list(list(name = "youtube",
                     link = "https://youtube.com/R2Rpkg"))
),
c = list(
  name = "Maximillian Qian",
  title = "Code Cleaner",
  image = "https://r2social.obi.obianom.com/misc/team2.jpg",
  social = list(list(name = "facebook",
                     link = "https://facebook.com/R2Rpkg"))
)
))

Display Social Links on Profile Card

Description

Social profile card for a any profile

Usage

profileDisplay2(item)
profileDisplay2(item)

Arguments

item

list of profiles along with their image and other items

Value

HTML of social links displayed on a card

Examples


profileDisplay2(
  list(
    a = list(
      name = "Obi Obianom",
      image = "https://r2social.obi.obianom.com/misc/team3.jpg",
      social = list(
        list(
          name = "x",
          link = "https://x.com/R2Rpkg"
        ),
        list(
          name = "linkedin",
          link = "https://linkedin.com/oobianom"
        ),
        list(
          name = "website",
          link = "https://obianom.com"
        ),
        list(
          name = "youtube",
          link = "https://youtube.com/R2Rpkg"
        )
      )
    ),
    b = list(
      name = "William Hane",
      title = "Core Developer",
      image = "https://r2social.obi.obianom.com/misc/team1.jpg",
      social = list(list(
        name = "youtube",
        link = "https://youtube.com/R2Rpkg"
      ))
    ),
    c = list(
      name = "Maximillian Qian",
      title = "Code Cleaner",
      image = "https://r2social.obi.obianom.com/misc/team2.jpg",
      social = list(list(
        name = "facebook",
        link = "https://facebook.com/R2Rpkg"
      ))
    )
  )
)

profileDisplay2(
  list(
    a = list(
      name = "Obi Obianom",
      image = "https://r2social.obi.obianom.com/misc/team3.jpg",
      social = list(
        list(
          name = "x",
          link = "https://x.com/R2Rpkg"
        ),
        list(
          name = "linkedin",
          link = "https://linkedin.com/oobianom"
        ),
        list(
          name = "website",
          link = "https://obianom.com"
        ),
        list(
          name = "youtube",
          link = "https://youtube.com/R2Rpkg"
        )
      )
    ),
    b = list(
      name = "William Hane",
      title = "Core Developer",
      image = "https://r2social.obi.obianom.com/misc/team1.jpg",
      social = list(list(
        name = "youtube",
        link = "https://youtube.com/R2Rpkg"
      ))
    ),
    c = list(
      name = "Maximillian Qian",
      title = "Code Cleaner",
      image = "https://r2social.obi.obianom.com/misc/team2.jpg",
      social = list(list(
        name = "facebook",
        link = "https://facebook.com/R2Rpkg"
      ))
    )
  )
)

Add r2social scripts

Description

Wrap functions needed for styling of the containers

Usage

r2social.scripts(name = "sharesocial")
r2social.scripts(name = "sharesocial")

Arguments

name

script file name

Value

scripts needed for styling

Examples


if (interactive()) {
  r2social.scripts()
}

if (interactive()) {
  r2social.scripts()
}

Add social buttons to share a page

Description

Customize social buttons available for sharing of pages

Usage

shareButton(
  link,
  image = NULL,
  text = NULL,
  position = c("left", "right", "inline"),
  text.color = "black",
  plain = FALSE,
  facebook = TRUE,
  linkedin = TRUE,
  bg.col = NULL,
  x = FALSE,
  tumblr = FALSE,
  pinterest = FALSE,
  whatsapp = FALSE,
  reddit = FALSE,
  blogger = FALSE,
  weibo = FALSE,
  tiktok = FALSE,
  vk = FALSE,
  telegram = FALSE,
  visit.us = FALSE
)
shareButton(
  link,
  image = NULL,
  text = NULL,
  position = c("left", "right", "inline"),
  text.color = "black",
  plain = FALSE,
  facebook = TRUE,
  linkedin = TRUE,
  bg.col = NULL,
  x = FALSE,
  tumblr = FALSE,
  pinterest = FALSE,
  whatsapp = FALSE,
  reddit = FALSE,
  blogger = FALSE,
  weibo = FALSE,
  tiktok = FALSE,
  vk = FALSE,
  telegram = FALSE,
  visit.us = FALSE
)

Arguments

`link`	the link to share on social media
`image`	the image link to share on social media
`text`	the text to share on social media
`position`	of buttons e.g "left","right","bottom","inline"
`text.color`	text color e.g black
`plain`	logical. with or without background
`facebook`	share on Facebook
`linkedin`	share on Linkedin
`bg.col`	background color for the icons.
`x`	share on Twitter
`tumblr`	share on Tumblr
`pinterest`	share on Pinterest
`whatsapp`	share on Whatsapp
`reddit`	share on Reddit
`blogger`	share on Blogger
`weibo`	share on Weibo
`tiktok`	share on Tiktok
`vk`	share on VK or VKontakte
`telegram`	share on Telegram
`visit.us`	share on custom link

Value

Share link button via social media platforms

Examples for r2social

More examples and demo pages are located at this link - https://r2social.obi.obianom.com.

Note

'bg.col' argument is only functional if 'plain' argument is set to false

Examples

# Basic examples
# Let's make r2 social great again!
shareButton(link = "http://rpkg.net", position = "left")
shareButton(link = "http://obianom.com", position = "right")
shareButton(link = "https://shinyappstore.com/", plain = TRUE, position = "inline") #plain styling
shareButton(link = "https://shinyappstore.com/", plain = FALSE, position = "inline") #beautified

# Basic examples
# Let's make r2 social great again!
shareButton(link = "http://rpkg.net", position = "left")
shareButton(link = "http://obianom.com", position = "right")
shareButton(link = "https://shinyappstore.com/", plain = TRUE, position = "inline") #plain styling
shareButton(link = "https://shinyappstore.com/", plain = FALSE, position = "inline") #beautified

Customizable social icons

Description

For use in making buttons to share a page or connect to your social media

Usage

socialButtons(
  link,
  type = c("share", "connect"),
  image = NULL,
  text = NULL,
  plain = FALSE,
  position = c("left", "right", "inline"),
  text.color = "white",
  bg.col = NULL,
  facebook = FALSE,
  linkedin = FALSE,
  x = FALSE,
  tumblr = FALSE,
  pinterest = FALSE,
  whatsapp = FALSE,
  reddit = FALSE,
  instagram = FALSE,
  blogger = FALSE,
  weibo = FALSE,
  tiktok = FALSE,
  vk = FALSE,
  baidu = FALSE,
  telegram = FALSE,
  youtube = FALSE,
  visit.us = FALSE,
  link.out = FALSE
)
socialButtons(
  link,
  type = c("share", "connect"),
  image = NULL,
  text = NULL,
  plain = FALSE,
  position = c("left", "right", "inline"),
  text.color = "white",
  bg.col = NULL,
  facebook = FALSE,
  linkedin = FALSE,
  x = FALSE,
  tumblr = FALSE,
  pinterest = FALSE,
  whatsapp = FALSE,
  reddit = FALSE,
  instagram = FALSE,
  blogger = FALSE,
  weibo = FALSE,
  tiktok = FALSE,
  vk = FALSE,
  baidu = FALSE,
  telegram = FALSE,
  youtube = FALSE,
  visit.us = FALSE,
  link.out = FALSE
)

Arguments

`link`	link address to share
`type`	type of social button e.g. share or connect
`image`	image link for pinterest only
`text`	text link for x only
`plain`	logical. with or without background
`position`	position of buttons e.g "left","right","bottom","inline"
`text.color`	text color
`bg.col`	background color for the icons.
`facebook`	share on Facebook
`linkedin`	share on Linkedin
`x`	share on Twitter
`tumblr`	share on Tumblr
`pinterest`	share on Pinterest
`whatsapp`	share on Whatsapp
`reddit`	share on Reddit
`instagram`	share on Instagram
`blogger`	share on Blogger
`weibo`	share on Weibo
`tiktok`	share on Tiktok
`vk`	share on VK or VKontakte
`baidu`	share on Baidu
`telegram`	share on Telegram
`youtube`	share on Youtube
`visit.us`	visit a direct link
`link.out`	hyperlink to a page

Value

Social links button to be placed on pages

Examples for r2social

More examples and demo pages are located at this link - https://rpkg.net/package/r2social.

Note

'bg.col' argument is only functional if 'plain' argument is set to false

Examples

# styled
socialButtons("https://shinyappstore.com/",facebook = TRUE)

# plain
socialButtons("https://shinyappstore.com/",plain=TRUE, linkedin = TRUE)

# styled
socialButtons("https://shinyappstore.com/",facebook = TRUE)

# plain
socialButtons("https://shinyappstore.com/",plain=TRUE, linkedin = TRUE)

Package 'r2social'

Help Index

Add Connect with us buttons

Description

Usage

Arguments

Value

Examples for r2social

Note

Examples

Display Social Links on Profile Card

Description

Usage

Arguments

Value

Examples

Display Social Links on Profile Card

Description

Usage

Arguments

Value

Examples

Add r2social scripts

Description

Usage

Arguments

Value

Examples

Add social buttons to share a page

Description

Usage

Arguments

Value

Examples for r2social

Note

Examples

Customizable social icons

Description

Usage

Arguments

Value

Examples for r2social

Note

Examples