Skip to content

Commit

Permalink
Fixing pkgdown grumblings
Browse files Browse the repository at this point in the history
  • Loading branch information
StevenMMortimer committed Nov 4, 2024
1 parent 0a3a1e2 commit 68c898a
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 10 deletions.
21 changes: 14 additions & 7 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
title: salesforcer
url: https://stevenmmortimer.github.io/salesforcer
url: https://stevenmmortimer.github.io/salesforcer/
template:
bootstrap: 5
params:
bootswatch: spacelab
ganalytics: UA-98603021-2
Expand All @@ -11,13 +12,19 @@ template:

home:
strip_header: true


template:
opengraph:
image:
src: man/figures/salesforcer.png
alt: "salesforcer package logo"

navbar:
type: default
left:
- text: "Articles"
icon: fas fa-book
menu:
menu:
- text: Getting Started
href: articles/getting-started.html
- text: Supported Queries
Expand All @@ -44,7 +51,7 @@ navbar:
- text: GitHub
icon: fa-github fa-lg
href: https://github.com/StevenMMortimer/salesforcer

reference:
- title: Authentication
desc: Function to authenticate to your Salesforce Org.
Expand Down Expand Up @@ -72,12 +79,12 @@ reference:
- '`sf_create_attachment`'
- '`sf_download_attachment`'
- '`sf_update_attachment`'
- '`sf_delete_attachment`'
- '`sf_delete_attachment`'
- title: Bulk API Functions
desc: Convenience functions to perform async CRUD and query operations.
contents:
- '`sf_run_bulk_query`'
- '`sf_run_bulk_operation`'
- '`sf_run_bulk_operation`'
- title: Report Functions
desc: Functions to create, retrieve, update, delete and query reports and their data.
contents:
Expand Down Expand Up @@ -139,7 +146,7 @@ reference:
- '`sf_list_rest_api_versions`'
- '`sf_list_resources`'
- '`sf_list_api_limits`'
- '`sf_list_objects`'
- '`sf_list_objects`'
- '`sf_user_info`'
- '`sf_server_timestamp`'
- '`sf_set_password`'
Expand Down
2 changes: 1 addition & 1 deletion index.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ options(tibble.print_min = 5L, tibble.print_max = 5L)
<!-- badges: end -->

<br>
<img src="man/figures/salesforcer.png" width="120px" align="right" />
<img src="man/figures/salesforcer.png" alt="salesforcer package logo" width="120px" align="right" />

{salesforcer} is an R package that connects to Salesforce Platform APIs using
tidy principles. The package implements actions from the REST, SOAP, Bulk 1.0,
Expand Down
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Status](https://codecov.io/gh/stevenmmortimer/salesforcer/branch/main/graph/badg
<!-- badges: end -->

<br>
<img src="man/figures/salesforcer.png" width="120px" align="right" />
<img src="man/figures/salesforcer.png" alt="salesforcer package logo" width="120px" align="right" />

{salesforcer} is an R package that connects to Salesforce Platform APIs
using tidy principles. The package implements actions from the REST,
Expand Down
2 changes: 2 additions & 0 deletions vignettes/supported-queries.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,8 @@ new_contacts_res <- sf_create(new_contacts, "Contact", api_type = "Bulk 2.0")
**Performance test**

```{r run-performance-test, message=FALSE}
#| fig.alt: >
#| A violin plot showing the distribution of latency times for REST API and SOAP API
qry <- function(api_type){
sf_query(
sprintf("SELECT Id, Name, Owner.Id,
Expand Down
2 changes: 2 additions & 0 deletions vignettes/working-with-bulk-apis.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,8 @@ at a time). I would encourage users to experiment to see what works best in thei
Salesforce Org.

```{r, warning=FALSE, message=FALSE}
#| fig.alt: >
#| A violin plot showing the distribution of latency times for Bulk API and Bulk 2.0 API
soql <- "SELECT Id, Name FROM Contact"
bulk1_query <- function(){sf_query(soql, "Contact", api_type="Bulk 1.0")}
bulk2_query <- function(){sf_query(soql, api_type="Bulk 2.0")} # Bulk 2.0 doesn't need object name
Expand Down
2 changes: 1 addition & 1 deletion vignettes/working-with-reports.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Org. It typically follows the pattern: `https://na1.salesforce.com/00O/o`
you should see the results. Below is a screenshot of how a report may look in
your Org. Note the report Id in the URL bar.

![](./working-with-reports_files/report-screenshot.png)
![Alt](./working-with-reports_files/report-screenshot.png "A screenshot of the report id where it's embedded in the URL when viewing in a browser")

The report Id above (`"00O3s000006tE7zEAE"`) is the only information needed to pull
those same results from an R session, like so:
Expand Down

0 comments on commit 68c898a

Please sign in to comment.