Skip to content

Commit

Permalink
pkg down
Browse files Browse the repository at this point in the history
  • Loading branch information
gbganalyst committed Feb 6, 2024
1 parent 55549b4 commit 514d41a
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 6 deletions.
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,6 @@
^codecov\.yml$
^doc$
^Meta$
^_pkgdown\.yml$
^docs$
^pkgdown$
48 changes: 48 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/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]
release:
types: [published]
workflow_dispatch:

name: pkgdown

jobs:
pkgdown:
runs-on: ubuntu-latest
# Only restrict concurrency for non-PR jobs
concurrency:
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
permissions:
contents: write
steps:
- uses: actions/checkout@v4

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

- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::pkgdown, local::.
needs: website

- name: Build site
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
shell: Rscript {0}

- name: Deploy to GitHub pages 🚀
if: github.event_name != 'pull_request'
uses: JamesIves/github-pages-deploy-action@v4.5.0
with:
clean: false
branch: gh-pages
folder: docs
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
inst/doc
/doc/
/Meta/
docs
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Description: Designed to simplify and streamline the process of reading
workflows. Additionally, the package seamlessly works with labelled
data from SPSS and Stata.
License: MIT + file LICENSE
URL: https://github.com/gbganalyst/bulkreadr
URL: https://github.com/gbganalyst/bulkreadr, https://gbganalyst.github.io/bulkreadr/
BugReports: https://github.com/gbganalyst/bulkreadr/issues
Depends:
purrr
Expand Down
5 changes: 0 additions & 5 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,6 @@ This section provides a concise overview of the different functions available in
| [`read_stata_data()`](#read_stata_data) | [`fill_missing_values()`](#fill_missing_values) |







**Note:**

> For the majority of functions within this package, we will utilize data stored in the system file by the `bulkreadr`, which can be accessed using the `system.file()` function. If you wish to utilize your own data stored in your local directory, please ensure that you have set the appropriate file path prior to using any functions provided by the bulkreadr package.
Expand Down
4 changes: 4 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
url: https://gbganalyst.github.io/bulkreadr/
template:
bootstrap: 5

0 comments on commit 514d41a

Please sign in to comment.