pacman icon indicating copy to clipboard operation
pacman copied to clipboard
verified publisher icon trinker

Vignette for pacman

Open Dasonk opened this issue 13 years ago • 8 comments

Would a vignette be something we would want to make at some point? I'm thinking it would be a good idea but I'm too lazy to make one right now.

I'm assigning this to Milestone 2.0

I figure once we feel we can release the package to the general public either via advertising or a release on CRAN we'll turn the version number to 1.0. Once we've cleaned it up more and added a vignette we'll turn to 2.0.

Dasonk avatar Jun 03 '12 04:06 Dasonk

I agree. I know I need to make a vignette for the qdap package but pacman should be pretty intuitive. I think we could get away without a vignette on the first release.

trinker avatar Jun 03 '12 12:06 trinker

Hold off as R 3.0 and knitr 1.1 will play together to make vignettes: https://github.com/yihui/knitr/blob/master/NEWS.md

And officially...
http://yihui.name/knitr/demo/vignette/

I'd love to write this in markdown

trinker avatar Mar 03 '13 05:03 trinker

I started an Introduction to pacman vignette,

We need to make the following decisions:

  • [ ] pdf or html (which)?
  • [ ] if html css choice including (could use default)
  • [ ] outline (what to put in there) that will/could be used as a table of contents

trinker avatar Jun 21 '14 04:06 trinker

Thinking on the Outline

I think we're want this to be pretty light weight and include the most useful functions in that order. I think we may want to include a base equivalent if there exists (not sure on this) as a table; so for example:

pacman function base equivalent description
p_load install.packages + library loads and optionally installs packages
p_install install.packages installs packages from CRAN

Here's where I've done this for the dplyr package: https://github.com/trinker/dplyr_in_a_nutshell#relating-the-functions

My list of most useful function In order of usefulness

  1. p_load
  2. p_funs
  3. p_data
  4. p_unload
  5. p_temp
  6. p_cite
  7. p_delete
  8. p_vign
  9. p_ver
  10. ...

As I make this list I'm not sure order of importance is the best way to go. I'm going to look at hadley's vignettes and steal...

trinker avatar Jun 21 '14 14:06 trinker

Maybe a better approach is to categorize/group functions. This would help for making a staticdocs page anyway and force us to organize our thinking.

Here is my categorization:

  1. Installing, Loading, Unloading, Updating, & Deleting
    • _Installing and Loading_
      • p_load
      • p_install/p_get
      • p_temp
    • _Unloading_
      • p_unload
    • _Updating_
      • p_up/p_update
    • _Deleting_
      • p_del/p_delete
  2. Session Information
    • p_loaded
  3. Local Package Information
    • p_author
    • p_cite/p_citation
    • p_data
    • p_exists
    • p_funs/p_functions
    • p_help
    • p_info/p_information
    • p_inter/p_interactive
    • p_isloaded
    • p_news
    • p_ver/p_version
    • p_vign/p_vignette
  4. Internet Based Package Information
    • p_cran
    • p_search_any/p_sa
  5. Library Information
    • p_base
    • p_lib/p_library
    • p_path
    • p_sl/p_search_library
    • p_unlock
  6. pacman Tools
    • p_detectOS
    • p_isglobal
    • p_opendir

I think the table would only be for the first group and would be as follows:

pacman Function Base Equivalent Description
p_load install.packages + library Loads and Install Packages
p_install install.packages Install Packages from CRAN
p_temp NONE Install a Package Temporarily
p_unload detach Unloads Packages from the Search Path
p_update update.packages Update Out-of-Date Packages

Bur maybe this wouldn't be too hard to do for each section as a quick reference?

trinker avatar Jun 21 '14 15:06 trinker

I added a skeletal to the vignette per these comments so we can try it on. See:

http://htmlpreview.github.io/?https://github.com/trinker/pacman/blob/master/vignettes/Introduction_to_pacman.html

We will want:

  1. Better styling of the table (more like GitHub's)
  2. ...

We will want to think about styling here.

trinker avatar Jun 21 '14 16:06 trinker

I added a second vignette that's a quick reference of categorized functions. This uses the same tables as the intro vignette and they share the tables found in vignettes/tables for easier maintainability. Here are the two vignettes:

pacman Functions: Quick Reference
Introduction to pacman

trinker avatar Jul 02 '14 02:07 trinker

We have no References for the Intro vignette. Do we want to:

  1. Remove references
  2. Figure out appropriate references to put in there

trinker avatar Sep 24 '14 16:09 trinker