search

oobianom / quickcode

An R package made out of mine and Brice's scrapbook of much needed functions.
https://quickcode.obi.obianom.com
Other
5 stars 0 forks source link

PDF Documentation for quickcode 0.9 #33

Open brichard1638 opened 4 months ago

brichard1638 commented 4 months ago

There is no documentation for the get_active_conn function found in the 0.9 pdf version of quickcode. Did you create a documentation file for this function? There is, however, a documented link in RStudio's help section for this function - not sure why the .pdf is not showing this.

On a separate note, in the latest documentation file, the sort length function is incorrectly named. The function name should be sortLength not sort_length. Like the issue outlined above, the function is correctly defined in the helpl section of RStudio, but is not correctly reflected in the pdf file.

The same issue exists with the extract_IP function.

Perhaps this is due to CRAN's version 0.9 of quickcode continuing to show errors, although the pkg has been publicly released.

brichard1638 commented 4 months ago

While there is a current release to CRAN of quickcode 0.9, the package probably needs to be resubmitted to CRAN.

oobianom commented 4 months ago

Hey Brice, as I indicated in https://github.com/oobianom/quickcode/issues/30, Uwe Ligges requested for modifications to be made to v0.9 since the get_active_conn and extract_IP functions had issues in various operating systems that were unresolved. So I removed them from v0.9 for the submission to go through instead of waiting longer for us to resolved the issues. As for sortLength, I renamed the function prior to submission to sort_length, for the same reason that I mentioned to you initially about ease of function discovery within the RStudio environment in https://github.com/oobianom/quickcode/issues/26.

You may need to reinstall quickcode from CRAN in order to see all the latest updates and the modifications shipped with v0.9