Skip to content

Commit

Permalink
CRAN submission
Browse files Browse the repository at this point in the history
  • Loading branch information
TimTaylor committed Mar 11, 2021
1 parent 6dcf954 commit c8478cd
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 33 deletions.
6 changes: 3 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: reportfactory
Title: Lightweight Infrastructure for Handling Multiple R Markdown Documents
Version: 0.1.3.9000
Version: 0.2.0
Authors@R: c(
person("Thibaut", "Jombart", role = "aut", email = "[email protected]"),
person("Amy", "Gimma", role = "ctb", email = "[email protected]"),
Expand All @@ -11,8 +11,8 @@ Description: Provides an infrastructure for handling multiple R Markdown
reports, including automated curation and time-stamping of outputs,
parameterisation and provision of helper functions to manage dependencies.
License: MIT + file LICENSE
URL: https://github.com/reconhub/reportfactory
BugReports: https://github.com/reconhub/reportfactory/issues
URL: https://github.com/reconverse/reportfactory
BugReports: https://github.com/reconverse/reportfactory/issues
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# reportfactory (development version)
# reportfactory 0.2.0

## Bug fixes
* Fixes (#74) where files generated within the Rmd were not being copied
Expand Down
16 changes: 8 additions & 8 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ knitr::opts_chunk$set(
```

<!-- badges: start -->
[![R-CMD-check](https://github.com/reconhub/reportfactory/workflows/R-CMD-check/badge.svg)](https://github.com/reconhub/reportfactory/actions)
[![Codecov test coverage](https://codecov.io/gh/reconhub/reportfactory/branch/master/graph/badge.svg)](https://codecov.io/gh/reconhub/reportfactory?branch=master)
[![R build status](https://github.com/reconhub/reportfactory/workflows/R-CMD-check/badge.svg)](https://github.com/reconhub/reportfactory/actions)
[![R-CMD-check](https://github.com/reconverse/reportfactory/workflows/R-CMD-check/badge.svg)](https://github.com/reconverse/reportfactory/actions)
[![Codecov test coverage](https://codecov.io/gh/reconverse/reportfactory/branch/master/graph/badge.svg)](https://codecov.io/gh/reconverse/reportfactory?branch=master)
[![R build status](https://github.com/reconverse/reportfactory/workflows/R-CMD-check/badge.svg)](https://github.com/reconverse/reportfactory/actions)
<!-- badges: end -->

# Welcome to reportfactory!
Expand All @@ -29,11 +29,11 @@ unreleased version. For those already using {reportfactory} in their pipelines
you can obtain the old version using the {remotes} package:

```{r installold, eval = FALSE}
remotes::install_github("reconhub/reportfactory@old_version")
remotes::install_github("reconverse/reportfactory@old_version")
```

You can also download it directly from
https://github.com/reconhub/reportfactory/releases/tag/old_version.
https://github.com/reconverse/reportfactory/releases/tag/old_version.

You can install the current version of the package from
[CRAN](https://cran.r-project.org/) with:
Expand All @@ -48,7 +48,7 @@ The development version can be installed from [GitHub](https://github.com/) with
if (!require(remotes)) {
install.packages("remotes")
}
remotes::install_github("reconhub/reportfactory", build_vignettes = TRUE)
remotes::install_github("reconverse/reportfactory", build_vignettes = TRUE)
```

## reportfactory in a nutshell
Expand All @@ -58,7 +58,7 @@ remotes::install_github("reconhub/reportfactory", build_vignettes = TRUE)
in well-organised, timestamped folders. This is illustrated in the figure below:

<br>
<img src="https://github.com/reconhub/reportfactory/raw/master/artwork/workflow.png" width="100%" alt="workflow">
<img src="https://github.com/reconverse/reportfactory/raw/master/artwork/workflow.png" width="100%" alt="workflow">
<br>

There a few key principles it adheres to:
Expand All @@ -84,7 +84,7 @@ There a few key principles it adheres to:
To install the development version of the package, use:

```{r install2, eval = FALSE}
remotes::install_github("reconhub/reportfactory")
remotes::install_github("reconverse/reportfactory")
```


Expand Down
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@

<!-- badges: start -->

[![R-CMD-check](https://github.com/reconhub/reportfactory/workflows/R-CMD-check/badge.svg)](https://github.com/reconhub/reportfactory/actions)
[![R-CMD-check](https://github.com/reconverse/reportfactory/workflows/R-CMD-check/badge.svg)](https://github.com/reconverse/reportfactory/actions)
[![Codecov test
coverage](https://codecov.io/gh/reconhub/reportfactory/branch/master/graph/badge.svg)](https://codecov.io/gh/reconhub/reportfactory?branch=master)
coverage](https://codecov.io/gh/reconverse/reportfactory/branch/master/graph/badge.svg)](https://codecov.io/gh/reconverse/reportfactory?branch=master)
[![R build
status](https://github.com/reconhub/reportfactory/workflows/R-CMD-check/badge.svg)](https://github.com/reconhub/reportfactory/actions)
status](https://github.com/reconverse/reportfactory/workflows/R-CMD-check/badge.svg)](https://github.com/reconverse/reportfactory/actions)
<!-- badges: end -->

# Welcome to reportfactory\!
Expand All @@ -20,11 +20,11 @@ their pipelines you can obtain the old version using the {remotes}
package:

``` r
remotes::install_github("reconhub/reportfactory@old_version")
remotes::install_github("reconverse/reportfactory@old_version")
```

You can also download it directly from
<https://github.com/reconhub/reportfactory/releases/tag/old_version>.
<https://github.com/reconverse/reportfactory/releases/tag/old_version>.

You can install the current version of the package from
[CRAN](https://cran.r-project.org/) with:
Expand All @@ -40,7 +40,7 @@ The development version can be installed from
if (!require(remotes)) {
install.packages("remotes")
}
remotes::install_github("reconhub/reportfactory", build_vignettes = TRUE)
remotes::install_github("reconverse/reportfactory", build_vignettes = TRUE)
```

## reportfactory in a nutshell
Expand All @@ -51,7 +51,7 @@ storing outputs in well-organised, timestamped folders. This is
illustrated in the figure below:

<br>
<img src="https://github.com/reconhub/reportfactory/raw/master/artwork/workflow.png" width="100%" alt="workflow">
<img src="https://github.com/reconverse/reportfactory/raw/master/artwork/workflow.png" width="100%" alt="workflow">
<br>

There a few key principles it adheres to:
Expand All @@ -77,7 +77,7 @@ There a few key principles it adheres to:
To install the development version of the package, use:

``` r
remotes::install_github("reconhub/reportfactory")
remotes::install_github("reconverse/reportfactory")
```

## Quick start
Expand Down Expand Up @@ -133,8 +133,8 @@ Use `list_ouputs()` to view the report outputs.

``` r
list_outputs()
#> [1] "example_report/2021-03-08_T09-16-24/example_report.html"
#> [2] "example_report/2021-03-08_T09-16-24/example_report.Rmd"
#> [1] "example_report/2021-03-11_T09-55-40/example_report.html"
#> [2] "example_report/2021-03-11_T09-55-40/example_report.Rmd"
```

`compile_reports()` can also be used to pass a set of parameters to use
Expand All @@ -151,10 +151,10 @@ compile_reports(
#> - with parameters: grouped_plot = FALSE
#> All done!
list_outputs()
#> [1] "example_report/2021-03-08_T09-16-24/example_report.html"
#> [2] "example_report/2021-03-08_T09-16-24/example_report.Rmd"
#> [3] "example_report/regional/2021-03-08_T09-16-25/example_report.html"
#> [4] "example_report/regional/2021-03-08_T09-16-25/example_report.Rmd"
#> [1] "example_report/2021-03-11_T09-55-40/example_report.html"
#> [2] "example_report/2021-03-11_T09-55-40/example_report.Rmd"
#> [3] "example_report/regional/2021-03-11_T09-55-41/example_report.html"
#> [4] "example_report/regional/2021-03-11_T09-55-41/example_report.Rmd"
```

Note that reports can also be an integer or a logical vector, in which
Expand All @@ -172,7 +172,7 @@ the `factory_overview()` function:

``` r
factory_overview()
#> /tmp/RtmpWSy7OS/my_factory
#> /tmp/Rtmp1gxZ7u/my_factory
#> ├── README.md
#> ├── data
#> │ ├── clean
Expand All @@ -181,11 +181,11 @@ factory_overview()
#> ├── factory_config
#> ├── outputs
#> │ └── example_report
#> │ ├── 2021-03-08_T09-16-24
#> │ ├── 2021-03-11_T09-55-40
#> │ │ ├── example_report.Rmd
#> │ │ └── example_report.html
#> │ └── regional
#> │ └── 2021-03-08_T09-16-25
#> │ └── 2021-03-11_T09-55-41
#> │ ├── example_report.Rmd
#> │ └── example_report.html
#> ├── report_sources
Expand Down
8 changes: 4 additions & 4 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## Reason for update
* minor bugfix/workflow improvement.
* resolves a failing test I noticed on the macos checks.
* Important bug fix and minor workflow improvement

## Tested on
* Fedora 33, local R installation, R 4.0.3 (2020-10-10)
* win-builder, R Under development (unstable) (2021-02-13 r80000)
* Fedora 33, R Under development (unstable) (2021-03-10 r80084)
* win-builder, R Under development (unstable) (2021-03-10 r80084)

### R CMD check results for above environments
Status: OK
0 errors | 0 warnings | 0 note


Expand Down

0 comments on commit c8478cd

Please sign in to comment.