Skip to content

Commit

Permalink
natverse_setup_package
Browse files Browse the repository at this point in the history
  • Loading branch information
jefferis committed Aug 24, 2019
1 parent b225681 commit 75c98f1
Show file tree
Hide file tree
Showing 7 changed files with 731 additions and 29 deletions.
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@
^_pkgdown\.yml$
^docs$
^data-raw$
^LICENSE\.md$
^\.github$
54 changes: 54 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Getting help with nat.flybrains

Thanks for using nat.flybrains. We're sorry if you're having trouble, but don't worry,
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.flybrains package](https://github.com/natverse/nat.flybrains/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 or just _like_ it (click on the emoji button and add a thumbs up) to let us know you're having trouble too. You'll need to a GitHub login for this.
* 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.flybrains/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
prepare a reprex. Read the [Get help!](https://www.tidyverse.org/help/)
section of the tidyverse site for more information.

*Thanks for your help!*
49 changes: 29 additions & 20 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,28 +1,37 @@
Package: nat.flybrains
Type: Package
Title: Additional data for use with the NeuroAnatomy Toolbox (nat)
Package: nat.flybrains
Title: Additional data for use with the NeuroAnatomy Toolbox
(nat)
Version: 1.7.3
Authors@R: c(
person("Gregory", "Jefferis", email = "[email protected]",
role = c("aut"), comment = c(ORCID = "0000-0002-0587-9355")),
person("James", "Manton", email = "[email protected]",
role = c("aut", "cre"), comment = c(ORCID = "0000-0001-9260-3156"))
)
Description: Includes 3D brain surfaces, bridging and mirroring registrations,
and neuropil segmentations for various template brains.
Authors@R:
c(person(given = "Gregory",
family = "Jefferis",
role = "aut",
email = "[email protected]",
comment = c(ORCID = "0000-0002-0587-9355")),
person(given = "James",
family = "Manton",
role = c("aut", "cre"),
email = "[email protected]",
comment = c(ORCID = "0000-0001-9260-3156")))
Description: Includes 3D brain surfaces, bridging and mirroring
registrations, and neuropil segmentations for various template brains.
License: GPL-3
URL: https://github.com/jefferislab/nat.flybrains,
http://flybrain.mrc-lmb.cam.ac.uk/si/bridging/www/,
https://natverse.github.io
BugReports: https://github.com/jefferislab/nat.flybrains/issues
Depends:
R (>= 2.10),
nat.templatebrains (>= 0.6)
nat.templatebrains (>= 0.6),
R (>= 2.10)
Suggests:
testthat,
git2r,
spelling
LazyData: true
URL: https://github.com/jefferislab/nat.flybrains, http://flybrain.mrc-lmb.cam.ac.uk/si/bridging/www/
BugReports: https://github.com/jefferislab/nat.flybrains/issues
Encoding: UTF-8
RoxygenNote: 6.1.1
Remotes: jefferis/nat,
spelling,
testthat
Remotes:
jefferis/nat,
jefferislab/nat.templatebrains
Encoding: UTF-8
Language: en-GB
LazyData: true
RoxygenNote: 6.1.1
Loading

0 comments on commit 75c98f1

Please sign in to comment.