Skip to content

Commit

Permalink
Add the link to a Bioconductor-friendly GHA workflow
Browse files Browse the repository at this point in the history
Under the example READMEs, this commit adds a short paragraph
describing the Bioconductor-friendly GitHub Actions workflow
from `biocthis`. The README.md file was manually edited while
trying to keep the line length consistent with how it currently
is rendered. Rendereding manually following the steps at
https://github.com/r-lib/actions/blob/master/.github/workflows/render-readme.yaml
resulted in long lines instead of the nice broken up lines.

This commit and PR closes
r-lib#84 as discussed
previously.
  • Loading branch information
lcolladotor authored and jimhester committed May 11, 2020
1 parent aecb612 commit 8270690
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
26 changes: 26 additions & 0 deletions examples/README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,32 @@ the report as a build artifact.
print_yaml("docker.yaml")
```

## Bioconductor-friendly workflow

[Bioconductor](http://bioconductor.org/) is a repository for tools for
the analysis and comprehension of high-throughput genomic data that
hosts close to 2,000 R packages. It follows a six month release cycle
while R has a yearly release cycle. `biocthis` contains a
user-contributed workflow that is Bioconductor-friendly described in
detail at[the `biocthis` introductory vignette](https://lcolladotor.github.io/biocthis/articles/biocthis.html#use-bioc-github-action-).
You can add this workflow using the following R code:

```{r biocthis_gha, eval = FALSE}
## If needed
remotes::install_github("lcolladotor/biocthis")
## Create a GitHub Actions (GHA) workflow that is Bioconductor-friendly
biocthis::use_bioc_github_action()
## You can also use this GHA workflow without installing biocthis
usethis::use_github_action(
"check-bioc",
"https://bit.ly/biocthis_gha",
"check-bioc.yml"
)
```


## Forcing binaries

Code repositories such as [CRAN](http://cran.r-project.org) or [RStudio](http://rstudio.com)'s RSPM provide R packages in binary (= pre-compiled) form for some platforms, but these binaries can sometimes be missing our lag behind the package sources published on the repository.
Expand Down
25 changes: 25 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -709,6 +709,31 @@ jobs:
path: report.html
```

## Bioconductor-friendly workflow

[Bioconductor](http://bioconductor.org/) is a repository for tools for
the analysis and comprehension of high-throughput genomic data that
hosts close to 2,000 R packages. It follows a six month release cycle
while R has a yearly release cycle. `biocthis` contains a
user-contributed workflow that is Bioconductor-friendly described in
detail at[the `biocthis` introductory vignette](https://lcolladotor.github.io/biocthis/articles/biocthis.html#use-bioc-github-action-).
You can add this workflow using the following R code:

``` r
## If needed
remotes::install_github("lcolladotor/biocthis")
## Create a GitHub Actions (GHA) workflow that is Bioconductor-friendly
biocthis::use_bioc_github_action()
## You can also use this GHA workflow without installing biocthis
usethis::use_github_action(
"check-bioc",
"https://bit.ly/biocthis_gha",
"check-bioc.yml"
)
```

## Forcing binaries

Code repositories such as [CRAN](http://cran.r-project.org) or
Expand Down

0 comments on commit 8270690

Please sign in to comment.