Skip to content

Commit

Permalink
remove methods from imports (#87)
Browse files Browse the repository at this point in the history
* remove methods from imports

* bump version

* add back methods (still needed somehow?), suggest markdown, remove LazyData

* add markdown note to example

* update links

* update more links

* update link

* update email-address

* finish revdepcheck

* update checks
  • Loading branch information
ijlyttle authored Oct 4, 2021
1 parent d7fdb13 commit b2db0e4
Show file tree
Hide file tree
Showing 24 changed files with 250 additions and 130 deletions.
79 changes: 0 additions & 79 deletions .github/workflows/R-CMD-check.yaml

This file was deleted.

58 changes: 58 additions & 0 deletions .github/workflows/check-standard.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]

name: R-CMD-check

jobs:
R-CMD-check:
runs-on: ${{ matrix.config.os }}

name: ${{ matrix.config.os }} (${{ matrix.config.r }})

strategy:
fail-fast: false
matrix:
config:
- {os: macOS-latest, r: 'release'}
- {os: windows-latest, r: 'release'}
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
- {os: ubuntu-latest, r: 'release'}
- {os: ubuntu-latest, r: 'oldrel-1'}

env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
R_KEEP_PKG_SOURCE: yes

steps:
- uses: actions/checkout@v2

- uses: r-lib/actions/setup-pandoc@v1

- uses: r-lib/actions/setup-r@v1
with:
r-version: ${{ matrix.config.r }}
http-user-agent: ${{ matrix.config.http-user-agent }}
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v1
with:
extra-packages: rcmdcheck

- uses: r-lib/actions/check-r-package@v1

- name: Show testthat output
if: always()
run: find check -name 'testthat.Rout*' -exec cat '{}' \; || true
shell: bash

- name: Upload check results
if: failure()
uses: actions/upload-artifact@main
with:
name: ${{ runner.os }}-r${{ matrix.config.r }}-results
path: check
17 changes: 9 additions & 8 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Package: bsplus
Type: Package
Title: Adds Functionality to the R Markdown + Shiny Bootstrap Framework
Version: 0.1.2.9000
Version: 0.1.2.9001
Authors@R: c(
person(
given = "Ian",
family = "Lyttle",
email = "ian.lyttle@schneider-electric.com",
email = "ian.lyttle@se.com",
role = c("aut", "cre", "cph"),
comment = c(ORCID = "0000-0001-9962-4849"),
),
Expand All @@ -16,11 +16,11 @@ Authors@R: c(
)
Description: The Bootstrap framework lets you add some JavaScript functionality to your web site by
adding attributes to your HTML tags - Bootstrap takes care of the JavaScript
<https://getbootstrap.com/javascript>. If you are using R Markdown or Shiny, you can
<https://getbootstrap.com/docs/3.3/javascript/>. If you are using R Markdown or Shiny, you can
use these functions to create collapsible sections, accordion panels, modals, tooltips,
popovers, and an accordion sidebar framework (not described at Bootstrap site).
Please note this package was designed for Bootstrap 3.3.
License: MIT + file LICENSE
LazyData: TRUE
Depends: R (>= 3.3.0)
Imports:
htmltools,
Expand All @@ -29,15 +29,16 @@ Imports:
lubridate,
stringr,
rmarkdown,
methods,
glue,
jsonlite
jsonlite,
methods
URL: https://github.com/ijlyttle/bsplus
BugReports: https://github.com/ijlyttle/bsplus/issues
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.1.0
RoxygenNote: 7.1.1
Encoding: UTF-8
Suggests: testthat,
shiny,
covr,
knitr
knitr,
markdown
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# bsplus 0.1.2.9000 (development version)

- behind-the-scenes changes to remedy CRAN errors and notes

# bsplus 0.1.2

- adds `button_size` argument to `bs_button()` (#54)
Expand Down
2 changes: 1 addition & 1 deletion R/accordion.R
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
#' bs_set_opts(panel_type = "info") %>%
#' bs_append(title = "Paul McCartney", content = "Bass guitar, vocals")
#'
#' @seealso <http://getbootstrap.com/docs/3.3/javascript/#collapse-example-accordion>
#' @seealso <https://getbootstrap.com/docs/3.3/javascript/#collapse-example-accordion>
#' @export
#
bs_accordion <- function(id){
Expand Down
2 changes: 1 addition & 1 deletion R/button.R
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
#' @return Object with S3 class, `shiny.tag`, `<button/>`.
#' @examples
#' bs_button("Click me", button_type = "primary", button_size = "small")
#' @seealso <http://getbootstrap.com/docs/3.3/css/#buttons>
#' @seealso <https://getbootstrap.com/docs/3.3/css/#buttons>
#' @export
#'
bs_button <- function(
Expand Down
2 changes: 1 addition & 1 deletion R/carousel.R
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
#' bs_append(content = bs_carousel_image(src = "img/george.jpg")) %>%
#' bs_append(content = bs_carousel_image(src = "img/ringo.jpg"))
#'
#' @seealso <http://getbootstrap.com/docs/3.3/javascript/#carousel>,
#' @seealso <https://getbootstrap.com/docs/3.3/javascript/#carousel>,
#' [bs_carousel_image()], [bs_carousel_caption()]
#'
#' @export
Expand Down
2 changes: 1 addition & 1 deletion R/embed_popover.R
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
#'
#' @return `htmltools::[tag][htmltools::tag]`, modified copy of `tag`
#' @seealso [bs_embed_tooltip()],
#' <http://getbootstrap.com/docs/3.3/javascript/#popovers>
#' <https://getbootstrap.com/docs/3.3/javascript/#popovers>
#' @examples
#' library("htmltools")
#'
Expand Down
2 changes: 1 addition & 1 deletion R/embed_tooltip.R
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#' @param ... other named arguments, passed to `bs_set_data()`
#'
#' @return `htmltools::[tag][htmltools::tag]`, modified copy of `tag`
#' @seealso [bs_embed_popover()], <http://getbootstrap.com/docs/3.3/javascript/#tooltips>
#' @seealso [bs_embed_popover()], <https://getbootstrap.com/docs/3.3/javascript/#tooltips>
#' @examples
#' library("htmltools")
#' bs_button("I'm a button") %>%
Expand Down
2 changes: 1 addition & 1 deletion R/modal.R
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
#' \item{`bs_modal_closebutton()`}{`htmltools::[tag][htmltools::tag]`, `<button/>`}
#' }
#' @examples
#' library("htmltools")
#' library("htmltools") # also needs `markdown` package
#' library("shiny")
#'
#' bs_modal(id = "modal", title = "I'm a modal", body = "Yes, I am.")
Expand Down
2 changes: 1 addition & 1 deletion R/panel.R
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#' heading = tags$h3("title"),
#' body = tags$p("Some very important content")
#' )
#' @seealso <http://getbootstrap.com/docs/3.3/css/#panels>
#' @seealso <https://getbootstrap.com/docs/3.3/css/#panels>
#' @export
#'
bs_panel <- function(
Expand Down
2 changes: 1 addition & 1 deletion R/set_attr.R
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ bs_set_attr <- function(tag, .prefix = "data", ...){
#' bs_set_aria(expanded = FALSE)
#' @export
#'
#' @seealso [Bootstrap JavaScript Components](http://getbootstrap.com/docs/3.3/javascript)
#' @seealso [Bootstrap JavaScript Components](https://getbootstrap.com/docs/3.3/javascript/)
#
bs_set_data <- function(tag, ...){
bs_set_attr(tag, .prefix = "data", ...)
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![Coverage Status](https://img.shields.io/codecov/c/github/ijlyttle/bsplus/master.svg)](https://codecov.io/github/ijlyttle/bsplus?branch=master)
<!-- badges: end -->

Please note that if you are viewing this page at this package's [pkgdown site](http://ijlyttle.github.io/bsplus), despite the "released" tag, this site represents a recent *development* version of this package. The most-recent version of the development package has its own [pkgdown site](http://ijlyttle.github.io/bsplus/dev).
Please note that if you are viewing this page at this package's [pkgdown site](https://ijlyttle.github.io/bsplus/), despite the "released" tag, this site represents a recent *development* version of this package. The most-recent version of the development package has its own [pkgdown site](https://ijlyttle.github.io/bsplus/dev/).

## Installation

Expand All @@ -25,7 +25,7 @@ devtools::install_github("ijlyttle/bsplus")

## Introduction

To see all of this in action, you are referred to the [getting-started article](http://ijlyttle.github.io/bsplus/articles/bsplus.html) at this package's **pkgdown** site.
To see all of this in action, you are referred to the [getting-started article](https://ijlyttle.github.io/bsplus/articles/bsplus.html) at this package's **pkgdown** site.

The goals of this package are:

Expand All @@ -37,15 +37,15 @@ The goals of this package are:

#### Accordion-sidebar

This family of functions lets you build another dimension to your **shiny** apps, although you can still use it **rmarkdown** HTML documents, explained further in this [article](http://ijlyttle.github.io/bsplus/articles/accordion_sidebar.html).
This family of functions lets you build another dimension to your **shiny** apps, although you can still use it **rmarkdown** HTML documents, explained further in this [article](https://ijlyttle.github.io/bsplus/articles/accordion_sidebar.html).

#### Shiny-help links

These functions make it easier to incorporate help-documentation into your **shiny** apps - functions for incorporating tooltips, popovers, and modals into the labels of **shiny** inputs, explained further in this [article](http://ijlyttle.github.io/bsplus/articles/shiny_help_links.html).
These functions make it easier to incorporate help-documentation into your **shiny** apps - functions for incorporating tooltips, popovers, and modals into the labels of **shiny** inputs, explained further in this [article](https://ijlyttle.github.io/bsplus/articles/shiny_help_links.html).

#### Carousel

A carousel is a [Boostrap JavaScript component](http://getbootstrap.com/javascript/#carousel) used to enclose a set of (typically) images, providing controls to move slides back-and-forth - as shown in this [article](https://ijlyttle.github.io/bsplus/articles/carousel.html). I think that this could be a more-useful tool if an "easy" way can be found to populate a carousel with images produced by [**gganimate**](https://github.com/thomasp85/gganimate).
A carousel is a [Boostrap JavaScript component](https://getbootstrap.com/javascript/#carousel) used to enclose a set of (typically) images, providing controls to move slides back-and-forth - as shown in this [article](https://ijlyttle.github.io/bsplus/articles/carousel.html). I think that this could be a more-useful tool if an "easy" way can be found to populate a carousel with images produced by [**gganimate**](https://github.com/thomasp85/gganimate).

### Function families

Expand Down Expand Up @@ -103,4 +103,4 @@ This package draws inspiration from [**shinyBS**](https://ebailey78.github.io/sh

## Code of conduct

Please note that this project is released with a [Contributor Code of Conduct](http://ijlyttle.github.io/bsplus/CONDUCT.html). By participating in this project you agree to abide by its terms.
Please note that this project is released with a [Contributor Code of Conduct](https://ijlyttle.github.io/bsplus/CONDUCT.html). By participating in this project you agree to abide by its terms.
2 changes: 1 addition & 1 deletion man/bs_accordion.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/bs_button.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/bs_carousel.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/bs_embed_popover.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/bs_embed_tooltip.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/bs_modal.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions man/bs_panel.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/bs_set_data.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit b2db0e4

Please sign in to comment.