Re: [R] declaring GPL license

2010-10-14 Thread Marc Schwartz
On Oct 14, 2010, at 11:36 AM, Stacey Wood wrote:

> Thanks everyone.  Now I know that I should not include another copy of the 
> license, but where should I refer to the copies on 
> http://www.r-project.org/Licenses/? In the DESCRIPTION file?
> 
> Stacey




Not in the DESCRIPTION file.  :-)

Given the prior comments, I did some checking on the Recommended packages 
(presuming that they can be used as correct examples) and there seems to be 
some variability present. In some cases, the COPYING file is included in the 
main source package folder, so that it is available in the distribution of the 
package source tarball, but as Dirk noted, it is not installed. 

You can then include a LICENCE file in the 'inst' directory, where that file 
has content along the lines of the following (based upon V&R's MASS) for GPL2:


Copyrights
==




Licence
===

This is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2. 

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

Files share/licenses/GPL-2 in the R
(source or binary) distribution is a copy of version 2 
of the 'GNU General Public License'.
These can also be viewed at http://www.r-project.org/licenses/



So in the above case, the LICENCE file will be available in both the source and 
binary/installed versions of the package, but without duplicating the content 
of the full COPYING file.

HTH,

Marc


[[alternative HTML version deleted]]

__
R-help@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] declaring GPL license

2010-10-14 Thread Berwin A Turlach
G'day Stacey,

On Thu, 14 Oct 2010 12:36:20 -0400
Stacey Wood  wrote:

> Thanks everyone.  Now I know that I should not include another copy
> of the license, but where should I refer to the copies on
> http://www.r-project.org/Licenses/? In the DESCRIPTION file?

I used to mention that location in the License: line of the DESCRIPTION
file, after GPL (>=2).  But some versions ago, that line got
standardised and now it is no longer possible to put additional text
onto that line. 

I guess you could just add a line LicenceLocation:  As far as I
understand the documentation, you are free to add additional lines
beyond those described in "Writing R Extensions" to the DESCRIPTION
file.  Some entries described in the manual are optional and for those
that are not some restrictions may apply that have to be followed.

Personally, I decided not to put any such reference into the
DESCRIPTION file of my packages as I guess that people who worry about
the lisence will either look into the source package (where I have a
copy) or know how to find one. :)

HTH.

Cheers,

Berwin

__
R-help@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] declaring GPL license

2010-10-14 Thread Stacey Wood
Thanks everyone.  Now I know that I should not include another copy of the
license, but where should I refer to the copies on
http://www.r-project.org/Licenses/? In the DESCRIPTION file?

Stacey


On Thu, Oct 14, 2010 at 12:16 PM, Marc Schwartz wrote:

> On Oct 14, 2010, at 11:13 AM, Berwin A Turlach wrote:
>
> > G'day Marc,
> >
> > On Thu, 14 Oct 2010 10:46:39 -0500
> > Marc Schwartz  wrote:
> >
> >> If you want (and you should), create and include a file called
> >> "COPYING" in the 'inst' folder in the package, so that it gets copied
> >> to the main package directory upon installation. [...]
> >
> > But that would be against the wishes of R core, from the "Writing R
> > Extension" manual:
> >
> >   Whereas you should feel free to include a license file in your
> >   source distribution, please do not arrange to @emph{install} yet
> >   another copy of the @acronym{GNU} @file{COPYING} or
> >   @file{COPYING.LIB} files but refer to the copies on
> >   @url{http://www.r-project.org/Licenses/} and included in the
> >   @R{} distribution (in directory @file{share/licenses}).
> >
> > :)
> >
> > Cheers,
> >
> >   Berwin
>
>
> Yep. I stand corrected on that point. :-)
>
> Thanks also to Prof. Ripley, who noted my error as well.
>
> Regards,
>
> Marc
>
>

[[alternative HTML version deleted]]

__
R-help@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] declaring GPL license

2010-10-14 Thread Dirk Eddelbuettel

On 14 October 2010 at 11:16, Marc Schwartz wrote:
| On Oct 14, 2010, at 11:13 AM, Berwin A Turlach wrote:
| 
| > G'day Marc,
| > 
| > On Thu, 14 Oct 2010 10:46:39 -0500
| > Marc Schwartz  wrote:
| > 
| >> If you want (and you should), create and include a file called
| >> "COPYING" in the 'inst' folder in the package, so that it gets copied
| >> to the main package directory upon installation. [...]
| > 
| > But that would be against the wishes of R core, from the "Writing R
| > Extension" manual:
| > 
| > Whereas you should feel free to include a license file in your
| > source distribution, please do not arrange to @emph{install} yet
| > another copy of the @acronym{GNU} @file{COPYING} or
| > @file{COPYING.LIB} files but refer to the copies on
| > @url{http://www.r-project.org/Licenses/} and included in the
| > @R{} distribution (in directory @file{share/licenses}).
| > 
| > :)
| > 
| > Cheers,
| > 
| > Berwin
| 
| 
| Yep. I stand corrected on that point. :-)

As a minor addition, keeping COPYING in the top-level (as per my earlier
email) appears to satisfy the wishes of those at the FSF (include COPYING) as
well as R Core (do not install COPYING)) -- where files in inst/ will always
get installed.   It's also simply more visible at the top-level.

Dirk

-- 
Dirk Eddelbuettel | e...@debian.org | http://dirk.eddelbuettel.com

__
R-help@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] declaring GPL license

2010-10-14 Thread Marc Schwartz
On Oct 14, 2010, at 11:13 AM, Berwin A Turlach wrote:

> G'day Marc,
> 
> On Thu, 14 Oct 2010 10:46:39 -0500
> Marc Schwartz  wrote:
> 
>> If you want (and you should), create and include a file called
>> "COPYING" in the 'inst' folder in the package, so that it gets copied
>> to the main package directory upon installation. [...]
> 
> But that would be against the wishes of R core, from the "Writing R
> Extension" manual:
> 
>   Whereas you should feel free to include a license file in your
>   source distribution, please do not arrange to @emph{install} yet
>   another copy of the @acronym{GNU} @file{COPYING} or
>   @file{COPYING.LIB} files but refer to the copies on
>   @url{http://www.r-project.org/Licenses/} and included in the
>   @R{} distribution (in directory @file{share/licenses}).
> 
> :)
> 
> Cheers,
> 
>   Berwin


Yep. I stand corrected on that point. :-)

Thanks also to Prof. Ripley, who noted my error as well.

Regards,

Marc

__
R-help@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] declaring GPL license

2010-10-14 Thread Berwin A Turlach
G'day Marc,

On Thu, 14 Oct 2010 10:46:39 -0500
Marc Schwartz  wrote:

> If you want (and you should), create and include a file called
> "COPYING" in the 'inst' folder in the package, so that it gets copied
> to the main package directory upon installation. [...]

But that would be against the wishes of R core, from the "Writing R
Extension" manual:

Whereas you should feel free to include a license file in your
source distribution, please do not arrange to @emph{install} yet
another copy of the @acronym{GNU} @file{COPYING} or
@file{COPYING.LIB} files but refer to the copies on
@url{http://www.r-project.org/Licenses/} and included in the
@R{} distribution (in directory @file{share/licenses}).

:)

Cheers,

Berwin

__
R-help@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] declaring GPL license

2010-10-14 Thread Marc Schwartz
On Oct 14, 2010, at 10:06 AM, Stacey Wood wrote:

> Hi all,
> 
> I'm currently writing an R package and want to declare a GPL2 license.
> According to the license agreement, I'm supposed to display:
> 
>  "This program is free software; you can redistribute it and/or modify
>   it under the terms of the GNU General Public License as published by
>   the Free Software Foundation ... See the
>   GNU General Public License for more details."
> 
> When I add this statement to the description file, the package cannot be
> processed.  Where should I add this statement to appropriately cite the
> license?
> 
> Thanks,
> Stacey


Stacey,

Read the Package Structure section of the "Writing R Extensions" manual:

  http://cran.r-project.org/doc/manuals/R-exts.html#Package-structure

where you can see an example of the DESCRIPTION file, including the "License" 
field.

If you want (and you should), create and include a file called "COPYING" in the 
'inst' folder in the package, so that it gets copied to the main package 
directory upon installation. The content for that file (the GPL 2 license) is 
at:

  http://www.gnu.org/licenses/gpl-2.0.txt

HTH,

Marc Schwartz

__
R-help@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] declaring GPL license

2010-10-14 Thread Dirk Eddelbuettel

On 14 October 2010 at 11:06, Stacey Wood wrote:
| Hi all,
| 
| I'm currently writing an R package and want to declare a GPL2 license.
| According to the license agreement, I'm supposed to display:
| 
|   "This program is free software; you can redistribute it and/or modify
|it under the terms of the GNU General Public License as published by
|the Free Software Foundation ... See the
|GNU General Public License for more details."
| 
| When I add this statement to the description file, the package cannot be
| processed.  Where should I add this statement to appropriately cite the
| license?

I suggested you do these two steps:

  1)  In the file DESCRIPTION, set the License: field accordingly.

  2)  In the top-level directory of your sources, include the file COPYING.

That should do.

Dirk, not a lawyer and not playing one on TV either

-- 
Dirk Eddelbuettel | e...@debian.org | http://dirk.eddelbuettel.com

__
R-help@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.