Skip to content

Commit

Permalink
start
Browse files Browse the repository at this point in the history
  • Loading branch information
ironholds committed Aug 20, 2015
1 parent a199460 commit 36fb4f4
Show file tree
Hide file tree
Showing 13 changed files with 119 additions and 14 deletions.
9 changes: 9 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
^.*\.Rproj$
^\.Rproj\.user$
^Makefile$
^README.Rmd$
^.travis.yml$
^appveyor.yml$
^CONDUCT\.md$
^README\.Rmd$
^README-.*\.png$
17 changes: 5 additions & 12 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
# History files
.Rproj.user
.Rhistory
.Rapp.history

# Example code in package build process
*-Ex.R

# RStudio files
.Rproj.user/

# produced vignettes
vignettes/*.html
vignettes/*.pdf
.RData
src/*.o
src/*.so
src/*.dll
25 changes: 25 additions & 0 deletions CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributor Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating documentation,
submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for
everyone, regardless of level of experience, gender, gender identity and expression,
sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.

Examples of unacceptable behavior by participants include the use of sexual language or
imagery, derogatory comments or personal attacks, trolling, public or private harassment,
insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments,
commits, code, wiki edits, issues, and other contributions that are not aligned to this
Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed
from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant
(http:contributor-covenant.org), version 1.0.0, available at
http://contributor-covenant.org/version/1/0/0/
14 changes: 14 additions & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Package: humaniformat
Title: A Parser for Human Names
Version: 0.0.1
Author: Oliver Keyes
Maintainer: Oliver Keyes <[email protected]>
Description: Human names are complicated and nonstandard things. Humaniformat attempts to provide functions for parsing those names, making a best-guess attempt to distinguish sub-components such as prefixes, suffixes, middle names and salutations.
License: MIT + file LICENSE
LazyData: true
URL: https://github.com/ironholds/humaniformat/
BugReports: https://github.com/ironholds/humaniformat/issues
Suggests:
testthat
LinkingTo: Rcpp
Imports: Rcpp
4 changes: 4 additions & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Generated by roxygen2 (4.1.1): do not edit by hand

importFrom(Rcpp,sourceCpp)
useDynLib(humaniformat)
10 changes: 10 additions & 0 deletions R/humaniformat.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#' @title A Parser for Human Names
#'
#' @description Human names are complicated and nonstandard things. Humaniformat attempts to provide functions for parsing those names,
#' making a best-guess attempt to distinguish sub-components such as prefixes, suffixes, middle names and salutations.
#'
#' @docType package
#' @name humaniformat
#' @useDynLib humaniformat
#' @importFrom Rcpp sourceCpp
NULL
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# humaniformat
An R parser for human names
# A human name parser for R

Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.
20 changes: 20 additions & 0 deletions humaniformat.Rproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Version: 1.0

RestoreWorkspace: Default
SaveWorkspace: Default
AlwaysSaveHistory: Default

EnableCodeIndexing: Yes
UseSpacesForTab: Yes
NumSpacesForTab: 2
Encoding: UTF-8

RnwWeave: Sweave
LaTeX: pdfLaTeX

AutoAppendNewline: Yes

BuildType: Package
PackageUseDevtools: Yes
PackageInstallArgs: --no-multiarch --with-keep.source
PackageRoxygenize: rd,collate,namespace,vignette
12 changes: 12 additions & 0 deletions man/humaniformat.Rd
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/humaniformat.R
\docType{package}
\name{humaniformat}
\alias{humaniformat}
\alias{humaniformat-package}
\title{A Parser for Human Names}
\description{
Human names are complicated and nonstandard things. Humaniformat attempts to provide functions for parsing those names,
making a best-guess attempt to distinguish sub-components such as prefixes, suffixes, middle names and salutations.
}

3 changes: 3 additions & 0 deletions src/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*.o
*.so
*.dll
2 changes: 2 additions & 0 deletions src/humaniformat.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#include <Rcpp.h>
using namespace Rcpp;
4 changes: 4 additions & 0 deletions tests/testthat.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
library(testthat)
library(humaniformat)

test_check("humaniformat")
8 changes: 8 additions & 0 deletions tests/testthat/test.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

context("humaniformat")

test_that("humaniformat works", {

expect_true(TRUE)

})

0 comments on commit 36fb4f4

Please sign in to comment.