Skip to content

Commit

Permalink
Remove vignette abstracts and update NEWS
Browse files Browse the repository at this point in the history
- removed "Abstract" section from vignettes, as this is covered by the
  vignette "Introduction" section
- updated NEWS file to reflect addition of pkgdown site
- removed images from README, as these break in pkgdown
- made minor updates to pkgdown site to better match other SomaLogic R
  resources
  • Loading branch information
amanda-hi committed Mar 8, 2024
1 parent c74d9f4 commit 05dbda3
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# SomaScan.db 0.99.7
* Created pkgdown site
# SomaScan.db 0.99.8
* Launched pkgdown site

# SomaScan.db 0.99.6
* Updated vignette engine to use `knitr::rmarkdown`
Expand Down
11 changes: 7 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,16 @@ knitr::opts_chunk$set(
comment = "#>",
fig.path = "man/figures/README-"
)
ver <- desc::desc_get_version(".")
ver <- paste0("https://img.shields.io/badge/Version-", ver,
dcf <- read.dcf(file = file.path(".", "DESCRIPTION"))
if ( nrow(dcf) < 1L)
stop("DESCRIPTION file of package is corrupt.", call. = FALSE)
desc <- as.list(dcf[1L, ])
ver <- paste0("https://img.shields.io/badge/Version-", desc$Version,
"-success.svg?style=flat&logo=github")
```


# `SomaScan.db` <img src="inst/figures/logo.png" align="right" height="138" alt="" />
# SomaScan.db


<!-- badges: start -->
Expand All @@ -30,7 +33,7 @@ ver <- paste0("https://img.shields.io/badge/Version-", ver,
[![Bioc support](https://bioconductor.org/shields/posts/SomaScan.db.svg)](https://support.bioconductor.org/tag/SomaScan.db)
<!-- badges: end -->

# Oveview
# Overview

The `SomaScan.db` package is a platform-centric R package that provides
extended biological annotations for analytes in the SomaScan assay menu, using
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# `SomaScan.db` <img src="inst/figures/logo.png" align="right" height="138" alt="" />
# SomaScan.db

<!-- badges: start -->

Expand All @@ -17,7 +17,7 @@ rank](https://bioconductor.org/shields/downloads/release/SomaScan.db.svg)](https
support](https://bioconductor.org/shields/posts/SomaScan.db.svg)](https://support.bioconductor.org/tag/SomaScan.db)
<!-- badges: end -->

# Oveview
# Overview

The `SomaScan.db` package is a platform-centric R package that provides
extended biological annotations for analytes in the SomaScan assay menu,
Expand Down
4 changes: 2 additions & 2 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ footer:
left: [package, developed_by]
right: built_with
components:
logo: "<img src='inst/figures/logo.png' width='20'> "
logo: "<img src='favicon-16x16.png'>"

template:
bootstrap: 5
Expand All @@ -43,7 +43,7 @@ home:
text: >
[SomaDataIO](https://somalogic.github.io/SomaDataIO/) <br />
[SomaPlotr](https://somalogic.github.io/SomaPlotr/) <br />
[Canopy](https://github.com/SomaLogic/Canopy/) <br />
[Canopy (Python)](https://github.com/SomaLogic/Canopy/) <br />
[DataDelve Statistics](https://somalogic.com/datadelve-statistics/)
help:
title: Getting Help
Expand Down
1 change: 0 additions & 1 deletion vignettes/SomaScan-db.Rmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Introduction to SomaScan.db"
abstract: "Brief overview of an annotation package for SomaLogic SomaScan data."
package: "`r BiocStyle::pkg_ver('SomaScan.db')`"
output:
BiocStyle::html_document:
Expand Down
1 change: 0 additions & 1 deletion vignettes/advanced_usage_examples.Rmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Advanced Exploration of the SomaScan Menu"
abstract: "Advanced use cases of SomaScan.db, including SomaScan menu exploration examples."
package: "`r BiocStyle::pkg_ver('SomaScan.db')`"
output:
BiocStyle::html_document:
Expand Down
1 change: 0 additions & 1 deletion vignettes/example_adat_workflow.Rmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Example ADAT Workflow Using SomaScan.db"
abstract: "A short workflow illustrating the use of SomaScan.db to annotate SomaScan data (as an ADAT)."
package: "`r BiocStyle::pkg_ver('SomaScan.db')`"
output:
BiocStyle::html_document:
Expand Down

0 comments on commit 05dbda3

Please sign in to comment.