Skip to content

Commit 2487805

Browse files
committed
Update UI and docs
1 parent 1d781f0 commit 2487805

File tree

12 files changed

+72
-19
lines changed

12 files changed

+72
-19
lines changed

.Rbuildignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,8 @@
66
^run_tests\.R$
77
^.*\.dcf$
88
^LICENSE$
9+
^_pkgdown\.yml$
10+
^docs$
11+
^pkgdown$
12+
^\.github$
13+
^index\.md$

.github/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.html

.github/workflows/pkgdown.yaml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3+
on:
4+
push:
5+
branches: [main, master]
6+
pull_request:
7+
branches: [main, master]
8+
release:
9+
types: [published]
10+
workflow_dispatch:
11+
12+
name: pkgdown
13+
14+
jobs:
15+
pkgdown:
16+
runs-on: ubuntu-latest
17+
# Only restrict concurrency for non-PR jobs
18+
concurrency:
19+
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
20+
env:
21+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
22+
permissions:
23+
contents: write
24+
steps:
25+
- uses: actions/checkout@v3
26+
27+
- uses: r-lib/actions/setup-pandoc@v2
28+
29+
- uses: r-lib/actions/setup-r@v2
30+
with:
31+
use-public-rspm: true
32+
33+
- uses: r-lib/actions/setup-r-dependencies@v2
34+
with:
35+
extra-packages: any::pkgdown, local::.
36+
needs: website
37+
38+
- name: Build site
39+
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
40+
shell: Rscript {0}
41+
42+
- name: Deploy to GitHub pages 🚀
43+
if: github.event_name != 'pull_request'
44+
uses: JamesIves/github-pages-deploy-action@v4.4.1
45+
with:
46+
clean: false
47+
branch: gh-pages
48+
folder: docs

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ vignettes/*.pdf
1212
.Rproj.user
1313
inst/doc
1414
*.dcf
15+
docs

DESCRIPTION

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Title: Dynamic Web-Based Analytics for the Energy Industry
44
Description: A 'Shiny' web application for energy industry analytics.
55
Take an overview of the industry, measure Key Performance Indicators,
66
identify changes in the industry over time, and discover new relationships in the data.
7-
URL: https://github.com/paulgovan/eanalytics
7+
URL: https://github.com/paulgovan/eanalytics,
8+
http://paulgovan.github.io/eAnalytics/
89
BugReports: https://github.com/paulgovan/eanalytics/issues
910
Authors@R: person("Paul", "Govan", email = "pgovan1@aggienetwork.com", role = c("aut", "cre", "cph"), comment = c(ORCID = "0000-0002-1821-8492"))
1011
Depends:
@@ -21,7 +22,8 @@ Imports:
2122
shiny,
2223
shinydashboard,
2324
shinyWidgets
24-
RoxygenNote: 6.1.1
25+
Encoding: UTF-8
26+
RoxygenNote: 7.2.3
2527
Suggests: knitr,
2628
rmarkdown
2729
VignetteBuilder: knitr

NAMESPACE

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
export(eAnalytics)
44
import(energyr)
5-
import(shinytest)
65
importFrom(DT,"%>%")
76
importFrom(DT,dataTableOutput)
87
importFrom(DT,datatable)

R/eAnalytics.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
#' @importFrom shinydashboard dashboardPage dashboardHeader dropdownMenu
1717
#' messageItem dashboardSidebar sidebarMenu menuItem menuSubItem dashboardBody
1818
#' tabItems tabItem box tabBox
19-
#' @import shinytest
2019
#' @importFrom shinyWidgets dropdownButton tooltipOptions
2120
#' @export
2221
#' @seealso \url{http://paulgovan.github.io/eAnalytics/}

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33
![](http://cranlogs.r-pkg.org/badges/eAnalytics)
44
[![DOI](https://zenodo.org/badge/35055898.svg)](https://zenodo.org/badge/latestdoi/35055898)
55

6+
# eAnalytics
7+
68
<img src="https://github.com/paulgovan/eAnalytics/blob/master/inst/app/www/favicon.png?raw=true" style="width:25.0%" />
79

8-
# eAnalytics
10+
# Features
911
* Profile: take an overview of the industry
1012
* Performance: measure key performance indicators (KPIs)
1113
* Trends: identify changes in the industry over time

_pkgdown.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
url: http://paulgovan.github.io/eAnalytics/
2+
template:
3+
bootstrap: 5
4+

index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33
![](http://cranlogs.r-pkg.org/badges/eAnalytics)
44
[![DOI](https://zenodo.org/badge/35055898.svg)](https://zenodo.org/badge/latestdoi/35055898)
55

6+
# eAnalytics
7+
68
<img src="https://github.com/paulgovan/eAnalytics/blob/master/inst/app/www/favicon.png?raw=true" style="width:25.0%" />
79

8-
# eAnalytics
10+
# Features
911
* Profile: take an overview of the industry
1012
* Performance: measure key performance indicators (KPIs)
1113
* Trends: identify changes in the industry over time

inst/app/dependencies.r

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
require(d3heatmap)
21
require(dplyr)
32
require(DT)
43
require(energyr)
@@ -7,4 +6,3 @@ require(leaflet)
76
require(plotly)
87
require(shiny)
98
require(shinydashboard)
10-
require(shinytest)

inst/app/ui.r

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -156,24 +156,16 @@ shinydashboard::dashboardPage(
156156
height = 200,
157157
width = 175
158158
),
159-
shiny::h2("eAnalyics"),
159+
shiny::h2("eAnalytics"),
160160
shiny::h4("Dynamic Web-based Analytics for the Energy Industry"),
161161
br(),
162162
shiny::h4(
163163
"eAnalytics is a ",
164164
shiny::a(href = 'http://shiny.rstudio.com', 'Shiny'),
165-
"web application built on top of R for energy-related data analytics, powered by the excellent",
166-
shiny::a(href = 'https://plot.ly/r/', 'plotly'),
167-
",",
168-
shiny::a(href = 'https://rstudio.github.io/leaflet/', 'Leaflet'),
169-
",",
170-
shiny::a(href = 'https://rstudio.github.io/DT/', 'DT'),
171-
", and",
172-
shiny::a(href = 'https://cran.r-project.org/web/packages/googleVis/vignettes/googleVis_examples.html', 'googleVis'),
173-
"packages."
165+
"web application built on top of R for energy-related data analytics"
174166
),
175167
shiny::h4(
176-
"eAnalytics has the largest open database of US energy industry information, providing interactive and dynamic web-based analytics to industry stakeholders."
168+
"eAnalytics has the largest open database of US energy industry information, providing interactive web-based analytics to industry stakeholders."
177169
),
178170
shiny::h4("To get started, select an industry in the sidepanel."),
179171
br(),

0 commit comments

Comments
 (0)