Skip to content

Commit bbd0f50

Browse files
committed
remove doc link to gbutils::parse_text
1 parent d6b2bd2 commit bbd0f50

File tree

83 files changed

+234
-178
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+234
-178
lines changed

DESCRIPTION

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Package: Rdpack
22
Type: Package
33
Title: Update and Manipulate Rd Documentation Objects
4-
Version: 1.0.0
5-
Date: 2020-07-01
4+
Version: 1.0.1
5+
Date: 2020-07-02
66
Authors@R: c( person(given = c("Georgi", "N."),
77
family = "Boshnakov",
88
role = c("aut", "cre"),
@@ -35,4 +35,4 @@ Suggests:
3535
rprojroot
3636
License: GPL (>= 2)
3737
LazyLoad: yes
38-
RoxygenNote: 6.1.1
38+
RoxygenNote: 7.1.0

NEWS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# Rdpack 1.0.1
2+
3+
- removed a documentation link to a function in `gbutils`, which is not among
4+
the dependencies of `Rdpack`. This was raising a NOTE on one of the CRAN
5+
testing machines.
6+
7+
18
# Rdpack 1.0.0
29

310
- `viewRd()` now loads also Rd macros declared by the package to which the

README.md

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,28 @@ manipulation of references and Rd files.
1313

1414
# Table of Contents
1515

16-
1. [Installing Rdpack](#org5a186cb)
17-
2. [Inserting Bibtex references and citations](#org73284fd)
18-
1. [Preparation](#orgd31930f)
19-
2. [Inserting references](#orgc336482)
20-
3. [Inserting citations](#org7589243)
21-
4. [Changing the style of references](#orgd5ae5c4)
22-
5. [Troubleshooting](#orgac0ecbd)
23-
1. [A puzzling message in devtools development mode](#orgb8a5daa)
24-
2. [Typical errors](#org213c8d0)
25-
6. [Latex markup in BibTeX entries](#org440ee8d)
26-
7. [Encoding of file REFERENCES.bib](#orgf8af356)
27-
3. [Viewing Rd files](#org89d0e02)
28-
4. [Using Rdpack::reprompt()](#orgc30b9b4)
29-
1. [What it does](#orgcc21719)
30-
2. [Reprompt and open in an editor](#org9e948b4)
31-
5. [Inserting evaluated examples](#orgc92ac15)
32-
1. [Evaluating the examples in section Examples](#org2d6b6a4)
33-
6. [Inserting figures/graphs/plots](#org7b17d4f)
34-
7. [Versions of Rdpack](#orgb41cb0e)
35-
36-
37-
<a id="org5a186cb"></a>
16+
1. [Installing Rdpack](#org5f1d326)
17+
2. [Inserting Bibtex references and citations](#org02a1509)
18+
1. [Preparation](#org1ff2a2c)
19+
2. [Inserting references](#org39b5142)
20+
3. [Inserting citations](#org603f431)
21+
4. [Changing the style of references](#org65dead0)
22+
5. [Troubleshooting](#orgc04d19f)
23+
1. [A puzzling message in devtools development mode](#org979de5a)
24+
2. [Typical errors](#org4eec941)
25+
6. [Latex markup in BibTeX entries](#org9e62ca4)
26+
7. [Encoding of file REFERENCES.bib](#orgb296756)
27+
3. [Viewing Rd files](#orge7e0f29)
28+
4. [Using Rdpack::reprompt()](#org7e24b56)
29+
1. [What it does](#org0b5c4ca)
30+
2. [Reprompt and open in an editor](#org95cf7f2)
31+
5. [Inserting evaluated examples](#org0ae796d)
32+
1. [Evaluating the examples in section Examples](#org23ea2db)
33+
6. [Inserting figures/graphs/plots](#org3fcb893)
34+
7. [Versions of Rdpack](#orgdb25708)
35+
36+
37+
<a id="org5f1d326"></a>
3838

3939
# Installing Rdpack
4040

@@ -48,7 +48,7 @@ You can also install the [development version](https://github.com/GeoBosh/Rdpack
4848
install_github("GeoBosh/Rdpack")
4949

5050

51-
<a id="org73284fd"></a>
51+
<a id="org02a1509"></a>
5252

5353
# Inserting Bibtex references and citations
5454

@@ -62,7 +62,7 @@ the `DESCRIPTION` file of the package needs to be amended, see below the full
6262
details.
6363

6464

65-
<a id="orgd31930f"></a>
65+
<a id="org1ff2a2c"></a>
6666

6767
## Preparation
6868

@@ -93,7 +93,7 @@ enumerated below in somewhat more detail, see also the vignette
9393
put the BibTeX references in it.
9494

9595

96-
<a id="orgc336482"></a>
96+
<a id="org39b5142"></a>
9797

9898
## Inserting references
9999

@@ -141,7 +141,7 @@ or open it from `R`:
141141
[`Inserting_bibtex_references (development version on github)`](https://github.com/GeoBosh/Rdpack/blob/master/vignettes/Inserting_bibtex_references.pdf).)
142142

143143

144-
<a id="org7589243"></a>
144+
<a id="org603f431"></a>
145145

146146
## Inserting citations
147147

@@ -211,7 +211,7 @@ see also Murdoch (2010) and Francois (2014)
211211
in the list of references for `\insertAllCited`.
212212

213213

214-
<a id="orgd5ae5c4"></a>
214+
<a id="org65dead0"></a>
215215

216216
## Changing the style of references
217217

@@ -236,12 +236,12 @@ After installling/reloading your package the lists of references should appear
236236
with long author names. "Rdpack" itself now uses this style.
237237

238238

239-
<a id="orgac0ecbd"></a>
239+
<a id="orgc04d19f"></a>
240240

241241
## Troubleshooting
242242

243243

244-
<a id="orgb8a5daa"></a>
244+
<a id="org979de5a"></a>
245245

246246
### A puzzling message in devtools development mode
247247

@@ -262,7 +262,7 @@ session<sup><a id="fnr.1" class="footref" href="#fn.1">1</a></sup>. Even better,
262262
below to view the required help file.
263263

264264

265-
<a id="org213c8d0"></a>
265+
<a id="org4eec941"></a>
266266

267267
### Typical errors
268268

@@ -288,7 +288,7 @@ These errors occur during parsing of the Rd files, before the control is passed
288288
to the `Rdpack`'s macros.
289289

290290

291-
<a id="org440ee8d"></a>
291+
<a id="org9e62ca4"></a>
292292

293293
## Latex markup in BibTeX entries
294294

@@ -308,7 +308,7 @@ See also the overview help page, `help("Rdpack-package")`, of package `"Rdpack"`
308308
Among other things, it contains some dummy references which illustrate the above.
309309

310310

311-
<a id="orgf8af356"></a>
311+
<a id="orgb296756"></a>
312312

313313
## Encoding of file REFERENCES.bib
314314

@@ -340,7 +340,7 @@ add the encoding declaration to file DESCRIPTION<sup><a id="fnr.4" class="footre
340340
Needless to say, make sure that there are really no characters from encodings like 'latin1'.
341341

342342

343-
<a id="org89d0e02"></a>
343+
<a id="orge7e0f29"></a>
344344

345345
# Viewing Rd files
346346

@@ -362,12 +362,12 @@ sources in development mode. This should work also in development mode on any
362362
platform (e.g. RStudio, Emacs/ESS, Rgui).
363363

364364

365-
<a id="orgc30b9b4"></a>
365+
<a id="org7e24b56"></a>
366366

367367
# Using Rdpack::reprompt()
368368

369369

370-
<a id="orgcc21719"></a>
370+
<a id="org0b5c4ca"></a>
371371

372372
## What it does
373373

@@ -397,7 +397,7 @@ but it alerts the user to remove aliases, methods, and descriptions of arguments
397397
that have been removed.
398398

399399

400-
<a id="org9e948b4"></a>
400+
<a id="org95cf7f2"></a>
401401

402402
## Reprompt and open in an editor
403403

@@ -420,7 +420,7 @@ Elisp code), for example to be invoked on the currently edited file. Such a
420420
function and example key binding can be found at [georgisemacs](https://github.com/GeoBosh/georgisemacs).
421421

422422

423-
<a id="orgc92ac15"></a>
423+
<a id="org0ae796d"></a>
424424

425425
# Inserting evaluated examples
426426

@@ -446,7 +446,7 @@ The help page of `?Rdpack::promptUsage` contains a number of examples created wi
446446
Vignette [`Inserting_figures_and_evaluated_examples`](https://github.com/GeoBosh/Rdpack/blob/master/vignettes/Inserting_figures_and_evaluated_examples.pdf) gives further details.
447447

448448

449-
<a id="org2d6b6a4"></a>
449+
<a id="org23ea2db"></a>
450450

451451
## Evaluating the examples in section Examples
452452

@@ -471,7 +471,7 @@ and tangled along with examples in other documentation files<sup><a id="fnr.5" c
471471
using this feature is at [runExamplesCheck](https://github.com/GeoBosh/reprexes/tree/master/runExamplesCheck).
472472

473473

474-
<a id="org7b17d4f"></a>
474+
<a id="org3fcb893"></a>
475475

476476
# Inserting figures/graphs/plots
477477

@@ -489,7 +489,7 @@ package `"mypackage"`, and include the figure using `\figure`.
489489
See vignette [`Inserting_figures_and_evaluated_examples`](https://github.com/GeoBosh/Rdpack/blob/master/vignettes/Inserting_figures_and_evaluated_examples.pdf) for more details.
490490

491491

492-
<a id="orgb41cb0e"></a>
492+
<a id="orgdb25708"></a>
493493

494494
# Versions of Rdpack
495495

README.org

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@
99
#+END_EXPORT
1010
# Removing this, since doesn't seem to be updated anymore:
1111
# [![rpackages.io rank](http://www.rpackages.io/badge/Rdpack.svg)](http://www.rpackages.io/package/Rdpack)
12+
#
13+
# Saw these badges in Rcpp/README but they don't work for Rdpack
14+
# [![CRAN use](https://jangorecki.gitlab.io/rdeps/Rdpack/CRAN_usage.svg?sanitize=true)](https://cran.r-project.org/package=Rdpack)
15+
# [![CRAN indirect](https://jangorecki.gitlab.io/rdeps/Rdpack/indirect_usage.svg?sanitize=true)](https://cran.r-project.org/package=Rdpack)
16+
# [![BioConductor use](https://jangorecki.gitlab.io/rdeps/Rdpack/BioC_usage.svg?sanitize=true)](https://cran.r-project.org/package=Rdpack)
17+
1218

1319
Rdpack provides functions for manipulation of R documentation objects, including functions
1420
=reprompt()= and =ereprompt()= for updating existing Rd documentation for functions, methods

docs/404.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/authors.html

Lines changed: 21 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)