Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CRAN Submission issues #26

Closed
chainsawriot opened this issue May 8, 2024 · 4 comments
Closed

CRAN Submission issues #26

chainsawriot opened this issue May 8, 2024 · 4 comments

Comments

@chainsawriot
Copy link
Collaborator

For the CRAN check, there are two issues that make the incoming checks fail.

These two issues make the submission process very annoying. It's still not on cransay. I can't solve the issue of cpp11. But "inferencing" can be fixed here.

Maybe just call this "Minimal type converter" to reduce the friction.

@chainsawriot
Copy link
Collaborator Author

"Minimal type guesser" sounds less generic.

@chainsawriot chainsawriot mentioned this issue May 8, 2024
@chainsawriot chainsawriot changed the title Inferencing CRAN Submission issues May 8, 2024
@chainsawriot
Copy link
Collaborator Author

It's on cransays.

@chainsawriot
Copy link
Collaborator Author

Feedback from CRAN


If there are references describing the methods in your package, please
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")

Please add \value to .Rd files regarding exported methods and explain
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:
      as.col_spec.Rd: \value
      col_skip.Rd: \value
      cols.Rd: \value
      date_names.Rd: \value
      locale.Rd: \value
      parse_atomic.Rd: \value
      parse_factor.Rd: \value
      parse_guess.Rd: \value
      parse_vector.Rd: \value
      type_convert.Rd: \value

You write information messages to the console that cannot be easily
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 cat() rather use message()/warning() or if(verbose)cat(..)
(or maybe stop()) if you really have to write text to the console.
(except for print, summary, interactive functions) -> R/parser.R

Please always add all authors, contributors and copyright holders in the
Authors@R field with the appropriate roles.
 From CRAN policies you agreed to:
"The ownership of copyright and intellectual property rights of all
components of the package must be clear and unambiguous (including from
the authors specification in the DESCRIPTION file). Where code is copied
(or derived) from the work of others (including from R itself), care
must be taken that any copyright/license statements are preserved and
authorship is not misrepresented.
Preferably, an ‘Authors@R’ would be used with ‘ctb’ roles for the
authors of such code. Alternatively, the ‘Author’ field should list
these authors as contributors. Where copyrights are held by an entity
other than the package authors, this should preferably be indicated via
‘cph’ roles in the ‘Authors@R’ field, or using a ‘Copyright’ field (if
necessary referring to an inst/COPYRIGHTS file)." e.g.: The R Core Team
in DateTime.h
Please explain in the submission comments what you did about this issue.

@chainsawriot
Copy link
Collaborator Author

chainsawriot commented May 10, 2024

TODOS

(The first point on references doesn't apply)

  • Add @return to all functions?
  • Remove catwrap() NOT USED

minty/R/parser.R

Lines 620 to 623 in 9d007f6

cat_wrap <- function(header, body) {
body <- strwrap(body, exdent = nchar(header))
cat(header, paste(body, collapse = "\n"), "\n", sep = "")
}

  • Copyright issue

chainsawriot added a commit that referenced this issue May 10, 2024
chainsawriot added a commit that referenced this issue May 10, 2024
chainsawriot added a commit that referenced this issue May 10, 2024
chainsawriot added a commit that referenced this issue May 10, 2024
chainsawriot added a commit that referenced this issue May 10, 2024
Add \value
chainsawriot added a commit that referenced this issue May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant