updated vignette and readme around updated functions #7

	# 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: [devel] # Trigger on push to 'devel' branch
	pull_request:
	branches: [devel] # Trigger on PR to 'devel' branch
	release:
	types: [published]
	workflow_dispatch: # Allows manual triggering of the workflow

	name: pkgdown

	jobs:
	pkgdown:
	runs-on: ubuntu-latest
	concurrency:
	group: ${{ github.workflow }}-${{ 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

	- name: Install dependencies
	uses: r-lib/actions/setup-r-dependencies@v2
	with:
	extra-packages: any::pkgdown
	needs: website

	- name: Install package
	run: R CMD INSTALL .

	- 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/[email protected]
	with:
	clean: false # Keeps existing files on gh-pages that are not present in the current build
	branch: gh-pages # Target branch for the site deployment
	folder: docs # The folder where pkgdown outputs the site, adjust if your output directory is different

Provide feedback