Skip to content

Commit

Permalink
nat.devtools updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jefferis committed Aug 4, 2019
1 parent b896c34 commit 57f0de3
Show file tree
Hide file tree
Showing 6 changed files with 693 additions and 21 deletions.
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@ travisbuildchildren.sh
^build-cmtk.sh$
^_pkgdown\.yml$
^docs$
^LICENSE\.md$
^\.github$
^pkgdown$
55 changes: 55 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Getting help with nat.templatebrains

Thanks for using nat.templatebrains. We're sorry you're having trouble, but
we're here to help! To get help as quickly as possible, please read the following.

## Search
The first thing is to see if anyone has had your problem before:

* Search the [nat-user google group](https://groups.google.com/forum/#!forum/nat-user).
* Search GitHub for [_issues_ with the nat.templatebrains package](https://github.com/natverse/nat.templatebrains/issues).
* Search GitHub for [issues across the whole natverse](https://github.com/search?q=user%3Anatverse&type=Issues) in case
the problem is with a related package. You can add your own terms to the search
in the search box in the top left of that page.

If that solves your problem, then great!

## Known Problems
If you need more help with a known problem:

* If you found a relevant thread on the [nat-user google group](https://groups.google.com/forum/#!forum/nat-user):
please reply to that.
* If you found a GitHub issue:
please reply to that with more details (you'll need to a GitHub login) or just _like_ it to let us know you're having trouble too.
* If you're not sure:
ask a new question on the [nat-user google group](https://groups.google.com/forum/#!forum/nat-user)
linking to what you have found.


## New Problems
If it looks like a new problem then:

* If you just have a question:
please ask the [nat-user google group](https://groups.google.com/forum/#!forum/nat-user).
* If you need to report a *new* bug:
please [file an issue](https://github.com/natverse/nat.templatebrains/issues/new).
* If you're not sure:
please just ask the [nat-user google group](https://groups.google.com/forum/#!forum/nat-user)! If your
problem _is_ a bug or a feature request, you can easily return here and
report it - and we may be able to point you to an existing report or workaround.

## Good Questions and Bug Reports

* Be specific
* Include the code that triggered the problem
* If at all possible, make a minimal **repr**oducible **ex**ample (a *reprex*)

It will be much easier for us to help if we can run a *reprex* on
our own machine without your data. You might want to use sample data
from a nat package to help, or refer to publicly available data online.

You can use the [reprex](https://reprex.tidyverse.org/) package to help
and read the [Get help!](https://www.tidyverse.org/help/)
section of the tidyverse site for more information on this.

*Thanks for your help!*
45 changes: 26 additions & 19 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,29 +1,36 @@
Package: nat.templatebrains
Type: Package
Title: NeuroAnatomy Toolbox ('nat') Extension for Handling Template Brains
Package: nat.templatebrains
Title: NeuroAnatomy Toolbox ('nat') Extension for Handling
Template Brains
Version: 0.9
Authors@R: c(
person("Gregory", "Jefferis", email = "[email protected]",
role = c("aut", "cre"), comment = c(ORCID = "0000-0002-0587-9355")),
person("James", "Manton", email = "[email protected]",
role = c("aut"), comment = c(ORCID = "0000-0001-9260-3156"))
)
Description: Extends package 'nat' (NeuroAnatomy Toolbox) by providing objects
and functions for handling template brains.
Authors@R:
c(person(given = "Gregory",
family = "Jefferis",
role = c("aut", "cre"),
email = "[email protected]",
comment = c(ORCID = "0000-0002-0587-9355")),
person(given = "James",
family = "Manton",
role = "aut",
email = "[email protected]",
comment = c(ORCID = "0000-0001-9260-3156")))
Description: Extends package 'nat' (NeuroAnatomy Toolbox) by
providing objects and functions for handling template brains.
License: GPL-3
URL: https://github.com/jefferislab/nat.templatebrains
Depends:
nat (>= 1.8.6),
R (>= 2.10),
rgl,
nat (>= 1.8.6)
rgl
Imports:
igraph,
digest,
rappdirs,
memoise
igraph,
memoise,
rappdirs
Suggests:
testthat (>= 0.10),
git2r (>= 0.22.1),
nabor
URL: https://github.com/jefferislab/nat.templatebrains
RoxygenNote: 6.1.1
nabor,
testthat (>= 0.10)
Encoding: UTF-8
RoxygenNote: 6.1.1
BugReports: https://github.com/jefferislab/nat.templatebrains/issues
Loading

0 comments on commit 57f0de3

Please sign in to comment.