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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #40

Closed
andrie opened this issue Dec 12, 2014 · 1 comment
Closed

Improve documentation #40

andrie opened this issue Dec 12, 2014 · 1 comment
Assignees
@andrie
Labels
Documentation
Milestone
v0.2.3

Comments

@andrie
Copy link
Owner

andrie commented Dec 12, 2014

General improvements:

  • Fix package title to comply with new CRAN rules (60 chars, title case, no ending period)
  • Expand description
  • Categorise functions in package documentation improve groupings of functions using @family #19
  • Use @inheritParams to simplify documentation
@andrie andrie self-assigned this Dec 12, 2014
@andrie andrie added this to the Version 0.1-2 milestone Dec 12, 2014
andrie added a commit that referenced this issue Dec 12, 2014
@andrie
Update package level documentation. #40
d2dc2eb
andrie added a commit that referenced this issue Dec 12, 2014
@andrie
Added @inheritParams to simplify documentation. #40
4c626a4
andrie added a commit that referenced this issue Dec 14, 2014
@andrie
Added missing documentation argument. #40
0d48c1c
andrie added a commit that referenced this issue Dec 16, 2014
@andrie
Update documentation #40
d193861
andrie added a commit that referenced this issue Dec 16, 2014
@andrie
Renamed examples/example_addPackage.R to examples/example_addPackageL…
71d69b4 
…istingGithub.R #40
andrie added a commit that referenced this issue Dec 16, 2014
@andrie
Merged documentation for addPackage() and updatePackages() into singl…
ab5d64d 
…e topic #40. Also reduced example runtime #43.
andrie added a commit that referenced this issue Dec 16, 2014
@andrie
Updated package level documentation. #40
d1d3ad7
andrie added a commit that referenced this issue Dec 16, 2014
@andrie
Fix incorrect roxygen tag #40
73763f9
@andrie andrie modified the milestones: Version 0.2.2, Version 0.2.0 Jan 28, 2015
achubaty added a commit that referenced this issue Jan 28, 2015
@achubaty
added new functions to intro vignette
1f601f6 
part of #38 and #40

additions to intro vignette:
- adding new packages to existing miniCRAN repo
- adding old versions to existing repo
- updating package versions in miniCRAN repo
achubaty added a commit that referenced this issue Feb 2, 2015
@achubaty
rebuilt vignettes in inst/doc
588ab2a 
#38 and #40

use ` %\usepackage[utf8]{inputenc}`
@andrie
Copy link
Owner Author

andrie commented Mar 26, 2015

Version miniCRAN-0.2.2 includes additional vignettes, including information on how to use oldPackages() and updatePackages() as well as how to use miniCRAN with R-forge and BioConductor.

andrie added a commit that referenced this issue Mar 26, 2015
@andrie
Update and rebuild vignettes. #40
f9a8104
andrie added a commit that referenced this issue Mar 26, 2015
@andrie
Fix problems in vignette that prevented building on R-3.2.0 #40
7fe59da
@andrie andrie modified the milestones: Version 0.2.3, Version 0.2.2 Mar 26, 2015
andrie added a commit that referenced this issue Apr 12, 2016
@andrie
Ensure all examples run without problems. #40
aa104d2
@andrie andrie closed this as completed Apr 12, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@andrie andrie

Labels
Documentation
Projects
None yet
Milestone
v0.2.3
Development

No branches or pull requests
1 participant
@andrie