eriqande/gscramble

CRAN-required revisions during submission. From an email from Beni

Closed this issue · 1 comments

  • #46
    Probably because linebreaks count as spaces too.
    Please remove unecassary ones.

  • #47
    programming interface) names in single quotes in title and description.
    e.g: --> 'gscramble'
    Please note that package names are case sensitive.

  • #48
    add these in the description field of your DESCRIPTION file in the form
    authors (year) doi:...
    authors (year) arXiv:...
    authors (year, ISBN:...)
    or if those are not available: https:...
    with no space after 'doi:', 'arXiv:', 'https:' and angle brackets for
    auto-linking. (If you want to add a title as well please put it in
    quotes: "Title")

  • #49
    "F" as vector names.
    'T' and 'F' instead of TRUE and FALSE:
    man/create_GSP.Rd:
    create_GSP(
    pop1,
    pop2,
    F1 = F,
    F2 = F,
    F1B = F,
    F1B2 = F,
    AllowSinglePop = FALSE
    )

  • #50
    the functions results in the documentation. Please write about the
    structure of the output (class) and also what the output means. (If a
    function does not return a value, please document that too, e.g.
    \value{No return value, called for side effects} or similar)
    Missing Rd-tags:
    drop_segs_down_gsp.Rd: \value
    mat_scramble.Rd: \value
    perm_gs_by_pops.Rd: \value
    rearrange_genos.Rd: \value
    recomb_point.Rd: \value
    renumber_GSP.Rd: \value
    seg2tib.Rd: \value

  • #51
    (e.g. because of missing additional software, missing API keys, ...) by
    the user. That's why wrapping examples in \dontrun{} adds the comment
    ("# Not run:") as a warning for the user. Does not seem necessary.
    Please replace \dontrun with \donttest.
    Please unwrap the examples if they are executable in < 5 sec, or replace
    dontrun{} with \donttest{}.

  • #52
    suppressed.
    It is more R like to generate objects that can be used to extract the
    information a user is interested in, and then print() that object.
    Instead of print() rather use message()/warning() or
    if(verbose)print(..) (or maybe stop()) if you really have to write text
    to the console. (except for print, summary, interactive functions)
    -> R/sim_level_founder_haplos.R

Please fix and resubmit.

Best,
Benjamin Altmann

These updates passed all CRAN checks as before.