Skip to content

Commit

Permalink
turn off some examples for CRAN submission
Browse files Browse the repository at this point in the history
ref #75
  • Loading branch information
wibeasley committed Jan 18, 2021
1 parent 6f257b5 commit ce36291
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 36 deletions.
12 changes: 8 additions & 4 deletions R/get_dataframe.R
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
#' @inheritDotParams get_file
#'
#' @examples
#'
#' # Retrieve data.frame from dataverse DOI and file name
#' df_from_rds_ingested <-
#' get_dataframe_by_name(
Expand All @@ -35,13 +34,16 @@
#' server = "demo.dataverse.org"
#' )
#'
#' # Do not run when submitting to CRAN, because the whole
#' # example sometimes takes longer than 10 sec.
#' \dontrun{
#' # Retrieve ingested file originally a Stata dta
#' df_from_stata_ingested <-
#' get_dataframe_by_name(
#' filename = "nlsw88.tab",
#' dataset = "doi:10.70122/FK2/PPIAXE",
#' server = "demo.dataverse.org"
#' )
#' )
#'
#'
#' # To use the original file version, or for non-ingested data,
Expand All @@ -56,7 +58,7 @@
#' server = "demo.dataverse.org",
#' original = TRUE,
#' .f = readr::read_rds
#' )
#' )
#' }
#'
#' if (requireNamespace("haven", quietly = TRUE)) {
Expand All @@ -67,8 +69,10 @@
#' server = "demo.dataverse.org",
#' original = TRUE,
#' .f = haven::read_dta
#' )
#' )
#' }
#' }
#'
#' @export
get_dataframe_by_name <- function (
filename,
Expand Down
4 changes: 3 additions & 1 deletion cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ Description

This submission includes new features and updates to stay compliant with R checks.

A second change is that I am now the package maintainer, taking over from Thomas J. Leeper (thosjleeper@gmail.com).
A second change is that I am now the package maintainer, taking over from Thomas J. Leeper (thosjleeper@gmail.com). See https://github.com/IQSS/dataverse-client-r/issues/42 and https://github.com/IQSS/dataverse-client-r/issues/21.

The first submission on Jan 17/18 was rejected because the CRAN check had three notes that one documentation example exceeded 10 seconds. In response, I've added a `dontrun{}` block on most of that example.

Thank you for taking the time to review my submission, and please tell me if there's something else I should do for CRAN. -Will Beasley

Expand Down
2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ articles:
B-search: B-search.html
C-retrieval: C-retrieval.html
D-archiving: D-archiving.html
last_built: 2021-01-18T07:41Z
last_built: 2021-01-18T17:11Z
urls:
reference: https://IQSS.github.io/dataverse-client-r/reference
article: https://IQSS.github.io/dataverse-client-r/articles
Expand Down
36 changes: 10 additions & 26 deletions docs/reference/get_dataframe.html

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

12 changes: 8 additions & 4 deletions man/get_dataframe.Rd

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

0 comments on commit ce36291

Please sign in to comment.