Learn R Programming

hypothesis

Overview

hypothesis R package allows you to add, share and manage annotations for Shiny applications and R Markdown documents. It is a wrapper of cool hypothes.is tool.

Installation

# Latest development version
remotes::install_github("r-world-devs/hypothesis")

Usage

Shiny

Just call useHypothesis() within the app UI.

You can also (optionally) use hypothesisOnOff to allow turning annotations feature on/off with the returned button.

library(shiny)
library(hypothesis)

ui <- fluidPage(
  useHypothesis(),
  hypothesisOnOff(TRUE),
  br(),
  "Hello There General Kenobi"
)

server <- function(input, output, session) {

}

shinyApp(ui, server)

R Markdown

Just place useHypothesis() in document R chunk.

hypothesisOnOff work great as well.

Development

Rendering website

  1. Clone gh-pages branch as docs folder:
git clone -b gh-pages git@github.com:r-world-devs/hypothesis.git docs
  1. Render website pkgdown::build_site().
  2. Move to docs, commit and push.

Getting help

In a case you found any bugs, have feature request or general question please file an issue at the package Github. You may also contact the package author directly via email at krystian8207@gmail.com.

Copy Link

Version

Install

install.packages('hypothesis')

Monthly Downloads

196

Version

1.1.0

License

MIT + file LICENSE

Maintainer

Last Published

July 20th, 2023

Functions in hypothesis (1.1.0)

get_profile

Fetch profile information for the currently-authenticated user.
get_profile_groups

Fetch the groups for which the currently-authenticated user is a member.
useHypothesis

Use hypothesis annotations
hypothesisServices

Hypothesis Service Configuration
hypothesisOnOff

Turn On/Off Annotations Feature
as_json

Convert character string to JSON
get_groups

Get a list of groups
group

Operate with group
hs_api_handler

Handle hypothesis request
api_params

Request parameters
annotation

Operate with annotation
hypothesis-package

R wrapper for hypothes.is
hypothesisBranding

Branding configuration
search_annotations

Search for annotations