Skip to content

Commit

Permalink
Small R CMD check driven edits to vignettes and man pages
Browse files Browse the repository at this point in the history
  • Loading branch information
eddelbuettel committed Oct 9, 2023
1 parent cc3fb35 commit 20a6167
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 16 deletions.
2 changes: 1 addition & 1 deletion R/pruneRepo.R
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
##' @param type Character variable for the type of repository, so far
##' \dQuote{source}, \dQuote{binary}, \dQuote{win.binary}, \dQuote{mac.binary},
##' \dQuote{mac.binary.mavericks}, \dQuote{mac.binary.el-capitan},
##' \dQuote{mac.binary.big-sur-x86_64}, or \dQuote{both}
##' \dQuote{mac.binary.big-sur-x86_64},
##' \dQuote{mac.binary.big-sur-arm64}, or \dQuote{both}
##' @param pkg Optional character variable specifying a package name,
##' whose older versions should be pruned. If missing (the
Expand Down
8 changes: 4 additions & 4 deletions man/archivePackages.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 10 additions & 7 deletions man/pruneRepo.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion vignettes/CombiningDratAndTravis.html
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ <h1 class="title">Combining Drat and Travis CI</h1>
%\VignetteEncoding{UTF-8}
-->
<h2 id="what-is-travis-ci">What is Travis CI?</h2>
<p><a href="https://travis-ci.org/">Travis CI</a> is a hosted continuous integration service. It is integrated with GitHub and offers first class support for a number of languages, but importantly for us, R. Travis CI enables package authors to continually ensure their package always build and passes associated unit tests.</p>
<p><a href="https://www.travis-ci.com/">Travis CI</a> is a hosted continuous integration service. It is integrated with GitHub and offers first class support for a number of languages, but importantly for us, R. Travis CI enables package authors to continually ensure their package always build and passes associated unit tests.</p>
<p>Whenever a commit is pushed to a git repository that contains an R package, Travis CI attempts to build the associated R package (see <a href="https://github.com/craigcitro/r-travis">r-travis</a> for R specific examples). This ensures the repository always contains a working package. This vignette describes a modification to the standard Travis CI workflow. If a package build is successful, the package is then pushed to a <a href="http://dirk.eddelbuettel.com/code/drat.html">drat</a> repository.</p>
<h2 id="preliminaries">Preliminaries</h2>
<p>Unsurprisingly in order to integrate Travis CI with drat, you must first to have a <a href="https://github.com/eddelbuettel/drat">drat</a> repository and secondly add <a href="https://github.com/craigcitro/r-travis">Travis CI</a> support to that repository.</p>
Expand Down
2 changes: 1 addition & 1 deletion vignettes/CombiningDratAndTravis.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ css: "water.css"

## What is Travis CI?

[Travis CI](https://travis-ci.org/) is a hosted continuous integration service.
[Travis CI](https://www.travis-ci.com/) is a hosted continuous integration service.
It is integrated with GitHub and offers first class support for a number of languages,
but importantly for us, R.
Travis CI enables package authors to continually ensure their package always build and
Expand Down
2 changes: 1 addition & 1 deletion vignettes/DratForPackageAuthors.html
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ <h3 id="place-files-into-the-local-repo">Place Files into the Local Repo</h3>
<p>In either case, the package will be copied into the repo, and the PACKAGES file will be updated.</p>
<p>Lastly, if you have <code>git</code> (the command-line tool) or the wicked <a href="https://cran.r-project.org/package=git2r">git2r</a> package installed, then you can also use the <code>commit=TRUE</code> option to have the new files added and committed. Neither of these variant pushes, so that last step is left to the user (as it commonly requires authentication).</p>
<h3 id="github-and-travis-integration">GitHub and Travis Integration</h3>
<p><a href="https://github.com/csgillespie">Colin Gillespie</a> has provided a nice walk-through of how to have <a href="https://travis-ci.org/">Travis CI</a> automagically push packages into a <a href="https://dirk.eddelbuettel.com/code/drat.html">drat</a> repo. This is included as another (currently work-in-progress) vignette entitled <a href="https://github.com/eddelbuettel/drat/blob/master/vignettes/CombiningDratAndTravis.Rmd">Combining Drat And Travis</a> which can be found in the <a href="https://dirk.eddelbuettel.com/code/drat.html">drat</a> package just like this vignette.</p>
<p><a href="https://github.com/csgillespie">Colin Gillespie</a> has provided a nice walk-through of how to have <a href="https://www.travis-ci.com/">Travis CI</a> automagically push packages into a <a href="https://dirk.eddelbuettel.com/code/drat.html">drat</a> repo. This is included as another (currently work-in-progress) vignette entitled <a href="https://github.com/eddelbuettel/drat/blob/master/vignettes/CombiningDratAndTravis.Rmd">Combining Drat And Travis</a> which can be found in the <a href="https://dirk.eddelbuettel.com/code/drat.html">drat</a> package just like this vignette.</p>
<h2 id="case-2-using-another-server-or-local-storage">Case 2: Using Another Server or Local Storage</h2>
<p>Use of <a href="https://dirk.eddelbuettel.com/code/drat.html">drat</a> is not limited to GitHub. Any server you can</p>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion vignettes/DratForPackageAuthors.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ step is left to the user (as it commonly requires authentication).
### GitHub and Travis Integration

[Colin Gillespie](https://github.com/csgillespie) has provided a nice
walk-through of how to have [Travis CI](https://travis-ci.org/) automagically
walk-through of how to have [Travis CI](https://www.travis-ci.com/) automagically
push packages into a [drat](https://dirk.eddelbuettel.com/code/drat.html)
repo. This is included as another (currently work-in-progress) vignette
entitled [Combining Drat And
Expand Down

0 comments on commit 20a6167

Please sign in to comment.