book

R Packages

by Hadley Wickham

March 2015

Intermediate to advanced

202 pages

4h 23m

English

O'Reilly Media, Inc.

Read now

Unlock full access

In This BookConventions Used in This BookUsing Code ExamplesSafari® Books OnlineHow to Contact UsAcknowledgments
PhilosophyGetting StartedConventionsColophon
Naming Your PackageRequirements for a NameStrategies for Creating a NameCreating a PackageRStudio ProjectsWhat Is an RStudio Project File?What Is a Package?Source PackagesBundled PackagesBinary PackagesInstalled PackagesIn-Memory PackagesWhat Is a Library?
R Code WorkflowOrganizing Your FunctionsCode StyleObject NamesSpacingCurly BracesLine LengthIndentationAssignmentCommenting GuidelinesTop-Level CodeLoading CodeThe R LandscapeWhen You Do Need Side EffectsS4 Classes, Generics, and MethodsCRAN Notes
Dependencies: What Does Your Package Need?VersioningOther DependenciesTitle and Description: What Does Your Package Do?Author: Who Are You?On CRANLicense: Who Can Use Your Package?On CRANVersionOther Components
The Documentation WorkflowAlternative Documentation WorkflowRoxygen CommentsDocumenting FunctionsDocumenting DatasetsDocumenting PackagesDocumenting Classes, Generics, and MethodsS3S4RCSpecial CharactersDo Repeat YourselfInheriting Parameters from Other FunctionsDocumenting Multiple Functions in the Same FileText Formatting Reference SheetCharacter FormattingLinksListsMathematicsTables
Vignette WorkflowMetadataMarkdownSectionsListsInline FormattingTablesCodeKnitrOptionsDevelopment CycleAdvice for Writing VignettesOrganizationCRAN NotesWhere to Go Next
Test WorkflowTest StructureExpectationsWriting TestsWhat to TestSkipping a TestBuilding Your Own Testing ToolsTest FilesCRAN Notes

MotivationSearch PathThe NAMESPACEWorkflowExportsS3S4RCDataImportsR FunctionsS3S4Compiled Functions
Exported DataDocumenting DatasetsInternal DataRaw DataOther DataCRAN Notes
C++WorkflowDocumentationExporting C++ CodeImporting C++ CodeBest PracticesCGetting Started with .Call()Getting Started with .C()WorkflowExporting C CodeImporting C CodeBest PracticesDebugging Compiled CodeMakefilesOther LanguagesLicensingDevelopment WorkflowCRAN Issues
Package CitationOther Languages
Demos
RStudio, Git, and GitHubInitial SetupCreating a Local Git RepositorySeeing What’s ChangedRecording ChangesBest Practices for CommitsIgnoring FilesUndoing MistakesSynchronizing with GitHubBenefits of Using GitHubWorking with OthersIssuesBranchesMaking a Pull RequestSubmitting a Pull Request to Another RepoReviewing and Accepting Pull RequestsLearning More
WorkflowChecksCheck MetadataPackage StructureDescriptionNamespaceR CodeDataDocumentationDemosCompiled CodeTestsVignettesChecking After Every Commit with TravisBasic ConfigOther Uses
Version NumberBackward CompatibilityThe Submission ProcessTest EnvironmentsCheck ResultsReverse DependenciesCRAN PoliciesImportant FilesREADME.mdREADME.RmdNEWS.mdReleaseOn FailureBinary BuildsPrepare for Next VersionPublicizing Your PackageCongratulations!